External Message

Manage external message service.

List external messages

get

Retrieve a collection of external messages.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/external_messages

HTTPcURLJavaScriptPython

GET /api/external_messages HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "config_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "sender": "text",
      "sender_name": "text",
      "receiver": "text",
      "receiver_name": "text",
      "channel_name": "text",
      "channel_number": "text",
      "brand": "text",
      "did": "text",
      "msg_type": "UNKNOWN",
      "direction": "IN",
      "content": "text",
      "reason": "text",
      "delivery": "ERR",
      "provider_msg_id": "text",
      "created_at": "2017-07-21T17:32:28Z"
    }
  ]
}

Retrieve external message detailed information.

get

Retrieve details of external message.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of external message.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of external message.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

config_idall ofOptional

The unique ID of external message.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

senderstringOptional

The sender number of the message.

sender_namestringOptional

The sender name of the message.

receiverstringOptional

The receiver number of the message.

receiver_namestringOptional

The receiver name of the message.

channel_namestringOptional

The channel name of the message.

channel_numberstringOptional

The channel number of the message.

brandstringOptional

The brand of the message.

didstringOptional

The did of the message.

msg_typestring · enumOptional

The type of message:
Can be either:

• UNKNOWN:
• SMS:
• WHATSAPP:

Possible values:

directionstring · enumOptional

The direction of message:

• IN:
• OUT:

Possible values:

contentstringOptional

The content of the message.

reasonstringOptional

The reason of the message.

deliverystring · enumOptional

The delivery status of message:
Can be either:

• ERR:
• SENT:
• RECV:
• DELIVERED:

Possible values:

provider_msg_idstringOptional

The provider message ID of the message.

created_atall ofOptional

The creation time of the message.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

4XX

Error

get

/external_messages/{id}

HTTPcURLJavaScriptPython

GET /api/external_messages/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "config_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "sender": "text",
  "sender_name": "text",
  "receiver": "text",
  "receiver_name": "text",
  "channel_name": "text",
  "channel_number": "text",
  "brand": "text",
  "did": "text",
  "msg_type": "UNKNOWN",
  "direction": "IN",
  "content": "text",
  "reason": "text",
  "delivery": "ERR",
  "provider_msg_id": "text",
  "created_at": "2017-07-21T17:32:28Z"
}