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

4XX

Error

get

/external_messages

HTTPcURLJavaScriptPython

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

{
  "count": 1,
  "items": [
    {
      "id": null,
      "config_id": null,
      "sender": null,
      "sender_name": null,
      "receiver": null,
      "receiver_name": null,
      "channel_name": null,
      "channel_number": null,
      "brand": null,
      "did": null,
      "msg_type": null,
      "direction": null,
      "content": null,
      "reason": null,
      "delivery": null,
      "provider_msg_id": null,
      "created_at": null
    }
  ]
}

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

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": null,
  "config_id": null,
  "sender": null,
  "sender_name": null,
  "receiver": null,
  "receiver_name": null,
  "channel_name": null,
  "channel_number": null,
  "brand": null,
  "did": null,
  "msg_type": null,
  "direction": null,
  "content": null,
  "reason": null,
  "delivery": null,
  "provider_msg_id": null,
  "created_at": null
}