Channel Accounts

Operations of the Channel Gateway API. Paths are relative to your deployment's API host.

GET /api/channel-gateway-api/channel-accounts

List this org's channel accounts

Authentication: bearer token (Authorization: Bearer <token>)

StatusDescriptionBody
200application/json ChannelAccountDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/channel-gateway-api/channel-accounts

Create a channel account (originates its durable delegation)

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateChannelAccountDto

StatusDescriptionBody
201application/json ChannelAccountDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/channel-gateway-api/channel-accounts/{id}

Delete a channel account (revokes its delegation)

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
204
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/channel-gateway-api/channel-accounts/{id}/activate

Activate a channel account under a fresh durable delegation

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ChannelAccountDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/channel-gateway-api/channel-accounts/{id}/bindings/{bindingId}/turns/{turnId}/resend

Resend one UNCERTAIN reply (idempotent: a reply already SENT is returned as it is)

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
bindingIdpathstringyes
idpathstringyes
turnIdpathstringyes
StatusDescriptionBody
200application/json ChannelTurnDeliveryDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/channel-gateway-api/channel-accounts/{id}/deactivate

Deactivate a channel account (revokes its delegation)

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ChannelAccountDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/channel-gateway-api/channel-accounts/{id}/uncertain-turns

List a channel account's replies whose send outcome is unknown (UNCERTAIN)

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
limitquerynumbernoItems per page
pagequerynumbernoPage number (1-indexed)
StatusDescriptionBody
200application/json ChannelTurnDeliveryDtoPaginatedEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto