api:sms:get
Table of Contents
API : Sms Get
Introduction
This request will return an SMS/MMS message sent by a customer.
Request
| URL | https://api.telecomx.dk/sms/MESSAGE_ID | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER or MANAGER (cannot see content of messages), OWNER. RESELLER - can only see content of own messages. ADMIN. |
|
| Param | MESSAGE_ID | Id of the message (24-char hex string). |
Query examples
https://api.telecomx.dk/sms/1234567890ABCDEF12345678
Response
| JSON object | ||
|---|---|---|
| _id | Id | Id. |
| customer | Id | Id of customer. |
| type | String | Type of message: 'SMS' or 'MMS'. |
| message | String | The SMS message (max. 1Kb) or the MMS raw data (max. 512Kb). |
| from | String | Sender name or number (max 11 chars). |
| to | Array | List of phone numbers of the recipient, E.164 format |
| sent | Date | The date and time the message was sent, null if not yet sent. |
Note that properties holding no value may be omitted.
Response example
{ _id: '123457890ABCDEF12345678', customer: '123457890ABCDEF12345678', type: 'SMS', message: 'This is a test', from: 'Voicemail', to: ['+4581808888'], sent: '2014-01-01T12:34:56.789Z' }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | bad_request | Id not found in request URI |
| 404 | id | Message not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/sms/get.txt · Last modified: 2022/08/02 13:56 by Per Møller