Fetch SMS Messages

GET https://api.oneroute.io/api/public/channel/id/sms

Path Parameters

NameTypeDescription

id

String

channel id

Query Parameters

NameTypeDescription

status (Optional)

String

status of the messages to fetch. Must be delivered, pending or undelivered.

page[size]*

String

the limit of messages per page

page[number]*

String

page to load e.g 1, 2

Headers

NameTypeDescription

apikey*

String

API key

{
    "data": [
        {
            "id": "8d06688b-a050-4c40-89df-9ae0df36cb2c",
            "phone": null,
            "identifier": "support",
            "medium": "EMAIL",
            "credentials": {
                "email": "support@mail.oneroute.io",
                "emailDomain": "mail.oneroute.io"
            },
            "description": "Email Account to Sendgrid",
            "name": "support@mail.oneroute.io",
            "type": "CUSTOM",
            "provider": null,
            "country": "NG",
            "env": "LIVE",
            "status": "ACTIVE",
            "webhookUrl": null,
            "createdAt": "2021-07-16T07:56:41.226Z",
            "updatedAt": "2021-07-16T07:56:41.226Z"
      }
    ],
    "message": "Channels fetched successfully",
    "success": true
}

Last updated