Use this to send a location to a user. type value is 7.
{
"txnid": "542324",
"receiver": {
"type": 2,
"address": "9053XXXXXXXX"
},
"composition": {
"list": [{
"type": 7,
"location": {
"lat": "80",
"lon": "120",
"title": "Sample title",
"desc": "Sample description",
"zoomlevel": "2"
}
}]
}
} | 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. |
| *location | object | |
| *lat | string | Latitude |
| *lon | string | Longitude |
| *title | string | Location title |
| *desc | string | Location description |
| *zoomlevel | string | Zoom level |
lat cannot be null or empty; must be between -90 and 90. [1012]lon cannot be null or empty; must be between -180 and 180. [1012]title length must not exceed limits (set by service).desc length must not exceed limits (set by service).zoomlevel cannot be null or empty; must be between 1 and 24. [1053]| resultcode | Description |
|---|---|
| 1012 | invalid latitude/longitude |
| 1053 | invalid location zoomlevel |