This resource is used to send text messages via SMS.
Note that this resource requires additional access rights and agreement in place that allows the usage of SMS, please contact your CSM to get information on pricing and how to amend your agreement.
GET
Method not supported.
POST
Mandatory parameters
| Name | Type | Description |
|---|---|---|
| customer_id | int | Kaisa's unique ID for customer. |
| msg | string | Text message to send |
| from_nr | string | Number or Name to send from |
| to_nr | String | Number to send to (e164 format) |
Optional parameters
| Name | Type | Description |
|---|---|---|
| flashsms | int | Send as flash SMS, 1=true |
| ttl | int | Time-to-live for SMS message |
Output
| Name | Type | Description |
|---|---|---|
| status | bool | True or false |
| msg | string | Additional information (may be empty) |
| id | int | Kaisa's unique ID for the SMS message |
PUT
Method not supported.
DELETE
Mandatory parameters
| Name | Type | Description |
|---|---|---|
| customer_id | int | Kaisa's unique ID for customer. |
| id | int | Id for the sms |
Or
| Name | Type | Description |
|---|---|---|
| customer_id | int | Kaisa's unique ID for customer. |
| to_date | string | Date for sms to be deleted up to |
With optional
| Name | Type | Description |
|---|---|---|
| from_date | string | Starting date for sms to be deleted |
What will happen?
It will clear any personal data from all specified SMS. Phone numbers will be anonymised and the SMS content will be removed.
Comments
0 comments
Please sign in to leave a comment.