Shares contact information. At least one phone number and at least one address can be added. type value is 10.
{
"txnid": "542324",
"receiver": {
"type": 2,
"address": "905XXXXXXXXX"
},
"composition": {
"list": [{
"type": 10,
"vCard": {
"name": "John",
"surname": "Doe",
"phonenumbers": ["9053XXXXXXXX", "905XXXXXXXXX"],
"addresses": [{
"address": "Example Street 123",
"postalcode": "34197",
"city": "Istanbul",
"country": "Turkey"
}]
}
}]
}
} | 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. |
| *vCard | object | Contact payload |
| *name | string | Contact first name |
| *surname | string | Contact surname |
| *phonenumbers | list | List of phone numbers |
| *addresses | list | List of addresses |
| *address | string | Address |
| *postalcode | string | Postal code |
| *city | string | City |
| *country | string | Country |
vCard must not be empty. [1027]name cannot be null or empty; max 200 characters. [1027]surname max 200 characters. [1028]phonenumbers can contain at most 3 numbers. Each must be 3–15 characters and MSISDN (E164) format. [1029]addresses can contain at most 3 entries. [1030]| resultcode | Description |
|---|---|
| 1027 | invalid contact name |
| 1028 | invalid contact surname |
| 1029 | invalid contact phonenumber |
| 1030 | invalid contact address |