Deployments.ai Docs
Runtime

Show a channel delivery

GET /v1/runs/{runId}/channel-deliveries/{deliveryId} · SDK getChannelDelivery · CLI deployments channel-delivery show

GET
/v1/runs/{runId}/channel-deliveries/{deliveryId}

Requires channels:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

runId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
deliveryId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ChannelDeliveryResponse

application/json
  1. response
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
updatedAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
version*number|||
environmentId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
projectId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
workspaceId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
attempts*number|||
bindingId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
channel*string
Value in"imessage""rcs""slack""sms""teams""telegram"
contentPreview*string
externalThreadKey*string
failedAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
lastError?string
object*"channel-delivery"
Value in"channel-delivery"
provider*string
Value in"aws_end_user_messaging_rcs""slack_cloudflare_edge""slack_edge""teams_bot_framework""telegram"
providerMessageId?string
runId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
sentAt?string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
status*string
Value in"failed""queued""sending""sent"
threadId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
curl -X GET "https://example.com/v1/runs/string/channel-deliveries/string"
{  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0,  "environmentId": "string",  "organizationId": "string",  "projectId": "string",  "workspaceId": "string",  "attempts": 0,  "bindingId": "string",  "channel": "imessage",  "contentPreview": "string",  "externalThreadKey": "string",  "failedAt": "2019-08-24T14:15:22Z",  "id": "string",  "lastError": "string",  "object": "channel-delivery",  "provider": "aws_end_user_messaging_rcs",  "providerMessageId": "string",  "runId": "string",  "sentAt": "2019-08-24T14:15:22Z",  "status": "failed",  "threadId": "string"}