Sign in

v1

latestOpenAPI 3.0.02026-07-244771176.5 KB
SMS

List SMS

Retrieves a list of SMS messages. You can limit the number of messages returned and filter by properties listed in the parameters section.

get/v2/sms

Query parameters

limitstring

Limit the number of SMS. Defaults to 100 for JSON.

pagestring

Page number in combination with limit. Defaults to 1 for JSON.

start_datestring string

Start date for SMS created, in RFC3339 format.

end_datestring string

End date for SMS created date, in RFC3339 format.

recipientstring

Recipient filter.

senderstring

Sender filter.

message_refstring

Message reference filter.

status'PENDING' | 'SENT' | 'FAILED' | 'DELIVERED' | 'ACCEPTED' | 'SOFT_BOUNCE' | 'HARD_BOUNCE' | 'OTHER' | 'REJECTED' | 'PENDING_APPROVAL' | 'SUBMITTED' | 'UNDELIVERABLE' | 'READ' nullable

Message status.

  • PENDING: Queued for processing.
  • SENT: Submitted to the provider.
  • FAILED: Failed because of an error from the provider, a carrier, or the handset.
  • DELIVERED: Delivered to handset.
  • ACCEPTED: Accepted by the provider and delivery might have been attempted (but is not confirmed).
  • SOFT_BOUNCE: Undeliverable due to handset being switched off, out of range or other temporary deliverability issue.
  • HARD_BOUNCE: Handset was disconnected.
  • OTHER: Any other DLR status from the provider.
  • REJECTED: Message pending approval was rejected by the Kudosity support team.
  • PENDING_APPROVAL: Message is pending approval by the Kudosity support team.
  • SUBMITTED: Message is submitted to the provider.
  • UNDELIVERABLE: Message is undeliverable.
  • READ: Message is read by the recipient.
format'JSON' | 'CSV' nullable

Response format

recipient_countriesstring[]

ISO 3166 country codes. https://www.iso.org/iso-3166-country-codes.html

direction'OUT' | 'IN' nullable

Message direction.

  • OUT: Sent to the provider.
  • IN: Sent from the provider.
order_byOrderByField[]

Sort order. Default is CREATED_AT_ASC.

Filter query parameters are added to the URL. Use as: ?limit=1&page=2&start_date=2024-01-01T00:00:00Z

Response

A list of SMS messages

total_recordsstring required
total_segmentsstring required

Example response

{
  "smses": [
    {
      "id": "2d2c8fb6-e514-4f5f-9706-0672b0259218",
      "recipient": "61478038915",
      "recipient_country": "AU",
      "sender": "61481074185",
      "sender_country": "AU",
      "message_ref": "ncc1701d",
      "message": "Report to the ready room! Opt-out reply STOP",
      "status": "delivered",
      "sms_count": "1",
      "is_gsm": true,
      "routed_via": "",
      "track_links": true,
      "direction": "OUT",
      "created_at": "2022-03-28T06:12:52.450674000Z",
      "updated_at": "2022-03-28T06:12:52.450674000Z"
    }
  ]
}