Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
texts

Find a specific text

Returns a single Text instance for a given text id

get/texts/{id}

Path parameters

idinteger required

An id of a text

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Response

successful operation

idinteger

An id of an action

fromNumberstring

Sender's phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076

toNumberstring

Recipient's phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076

attributesobject

Map of user-defined string attributes associated with an action

state'READY' | 'SELECTED' | 'CALLBACK' | 'FINISHED' | 'DISABLED' | 'SKIPPED' | 'DNC' | 'DUP' | 'INVALID' | 'TIMEOUT' | 'PERIOD_LIMIT' | 'RESTRICTED_NUMBER'

Current state of an action (READY, SELECTED, CALLBACK, DISABLED, FINISHED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT). See call states and results

campaignIdinteger

An id of broadcast if given text was sent as a part of text broadcast

batchIdinteger

An id of contact batch associated with an action

inboundboolean

An action inbound

createdinteger

The time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

modifiedinteger

The time when the given resource was modified, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

labelsstring[]

Labels associated with an action

messagestring

A text message

finalTextResult'SENT' | 'RECEIVED' | 'DNT' | 'TOO_BIG' | 'INTERNAL_ERROR' | 'CARRIER_ERROR' | 'CARRIER_TEMP_ERROR' | 'UNDIALED' | 'INVALID_NUMBER'

Result of text (SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED). See call states and results