---
title: "List external messages"
method: GET
path: "/external_messages"
tags: ["External Message"]
---

# List external messages

`GET /external_messages`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/external_messages`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/external_messages/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a collection of external messages.

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` object[]
    - `id` string: The unique ID of the resource.
    - `config_id` string: The unique ID of the resource.
    - `sender` string: The sender number of the message.
    - `sender_name` string: The sender name of the message.
    - `receiver` string: The receiver number of the message.
    - `receiver_name` string: The receiver name of the message.
    - `channel_name` string: The channel name of the message.
    - `channel_number` string: The channel number of the message.
    - `brand` string: The brand of the message.
    - `did` string: 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`:
    - `content` string: The content of the message.
    - `reason` string: The reason of the message.
    - `delivery` 'ERR' | 'SENT' | 'RECV' | 'DELIVERED': The delivery status of message: Can be either: - `ERR`: - `SENT`: - `RECV`: - `DELIVERED`:
    - `provider_msg_id` string: The provider message ID of the message.
    - `created_at` string, date_time: The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)