With the Boolky API you can integrate a number of functions, such as sending a message to both existing contacts and new ones, you can calculate how much it will cost before sending. You can add a contact whenever you have a new user. You can integrate all the functionality that we have, if some functionality is not enough or you have problems with integration, write to the support service and we will solve this issue as soon as possible.
You can use this endpoint to add contacts in our system. You can add contacts your groups. If you don't specify any group, contacts will be added to "All" group which is by default generated for you. Also if you have contacts saved in our system you can use contactIds in SEND SMS call.
{
"content": [
{
"name": "Emma Smith",
"phone": "+12508682818",
"birthday": "13-04-1993",
"gender": 1,
"mail": "[email protected]"
},
{
"name": "Olivia Munn",
"phone": "+17784845095",
"birthday": "13-04-1993",
"gender": 1,
"mail": "[email protected]"
},
{
"name": "Ava Gardner",
"phone": "+12508079925",
"birthday": "13-04-1993",
"gender": 1,
"mail": "[email protected]"
},
{
"name": "Isabella Rossellini",
"phone": "+12507129905",
"birthday": "13-04-1993",
"gender": 1,
"mail": "[email protected]"
}
],
"groupIds": [
1,
2,
3
]
}
Variable | Type | Validation | Required | Info |
---|---|---|---|---|
name | string | Min 1, Max 50 characters | true | Contact Name |
phone | string | Min 1 Number | true | Contact phone number |
birthDay | dateString | null | false | Contact birth day |
gender | integer | null | false | Contact gender male - 1, female - 2 |
null | false | Contact email address | ||
groupIds | int[] | null | false | Group Ids - for example [1,2,3] |
If everything went well, you can find contacts field[]. Single contact have this fields.
name, phone, groupIds, notValid, gender, mail
{
"result": {
"data": [
{
"id": 5817760,
"name": "Emma Smith",
"phone": "+12508682818",
"groupIds": [
0,
1,
2,
3
],
"notValid": false,
"gender": 1,
"mail": "[email protected]"
},
{
"id": 5817761,
"name": "Olivia Munn",
"phone": "+17784845095",
"groupIds": [
586
],
"notValid": true,
"gender": 1,
"mail": "[email protected]"
},
{
"id": 5817762,
"name": "Ava Gardner",
"phone": "+12508079925",
"groupIds": [
0,
1,
2,
3
],
"notValid": false,
"gender": 1,
"mail": "[email protected]"
},
{
"id": 5817763,
"name": "Isabella Rossellini",
"phone": "+12507129905",
"groupIds": [
586
],
"notValid": true,
"gender": 1,
"mail": "[email protected]"
}
],
"message": {
"localizedMessage": "Successfully added",
"messageKey": "success"
}
}
}
An error response can be obtained if you have the wrong api key
{
"error": {
"localizedMessage": "Session expired",
"messageKey": "sessionExpired"
}
}