This section explains the sendmsgserv example, validations, and possible error codes for each content type. Validations in the examples are content-specific; general message sending validations (e.g., txnid) are not repeated. Use this to send text to a user. type value is 0.
{
"txnid": "200",
"receiver": {
"type": 2,
"address": "9053XXXXXXXX"
},
"composition": {
"list": [{
"type": 0,
"message": "Hello world"
}]
}
} | Field | Value | Description |
|---|---|---|
| *txnid | string | Request id value |
| *receiver | object | |
| *type | int | Recipient address type. Values: 0 -> Hashed address 1 -> All addresses following the service 2 -> MSISDN (plain number) |
| *address | string | Address in the type specified by type. If type is 0, address is hashed (value provided by bipussu). If type is 1, address must not be in the request. If type is 2, provide the address in 905XXXXXXXXX format. |
| *composition | object | |
| *list | list | Messages to send; at least 1 item required. |
| *type | int | Message type. Values: 0 – Text 2 – Photo 3 – Audio 4 – Video 5 – Sticker 6 – Caps 7 – Location 9 – Finish Line 10 – Contact 13 – Template Media Message 14 – Document. Additional parameters depend on the selected type. |
| *message | string | Text message |
message cannot be null, empty, or longer than 2048 characters. [1004]size must not be provided. [1005]ratio must not be provided. [1006]itemid must not be provided. [1007]| resultcode | Description |
|---|---|
| 1004 | invalid content message |
| 1005 | invalid content size |
| 1006 | invalid content ratio |
| 1007 | invalid content item id |