Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

External Message

Retrieve external message detailed information.

Retrieve details of external message.

get/external_messages/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the external message.

Response

OK

idstring

The unique ID of the resource.

config_idstring

The unique ID of the resource.

senderstring

The sender number of the message.

sender_namestring

The sender name of the message.

receiverstring

The receiver number of the message.

receiver_namestring

The receiver name of the message.

channel_namestring

The channel name of the message.

channel_numberstring

The channel number of the message.

brandstring

The brand of the message.

didstring

The did of the message.

msg_type'UNKNOWN' | 'SMS' | 'WHATSAPP'

The type of message:
Can be either:

  • UNKNOWN:
  • SMS:
  • WHATSAPP:
direction'IN' | 'OUT'

The direction of message:

  • IN:
  • OUT:
contentstring

The content of the message.

reasonstring

The reason of the message.

delivery'ERR' | 'SENT' | 'RECV' | 'DELIVERED'

The delivery status of message:
Can be either:

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

The provider message ID of the message.

created_atstring date_time

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 response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "config_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "created_at": "2017-07-21T17:32:28Z"
}