Add contact
Base URL:
POST: https://api.smsgatewayapi.com/v1/contact
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Login and go to 'Advanced' - 'API authentication' to find the API keys | Required |
| client_secret | API client secret | Login and go to 'Advanced' - 'API authentication' to find the API keys | Required |
| phone | phone number | The phone number of the contact | Required |
| groupid | group ID | Group ID the contact will be added to | Required |
| firstname | first name | The first name of the contact | Optional |
| lastname | last name | The last name of the contact | Optional |
| birthday | birthday | Birthday of the contact. Format: yyyy-MM-dd | Optional |
| extra1 to extra8 | user defined fields | user defined fields, check your advanced settings | Optional |
| unsubscribed | unsubscribed | Optional |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/contact";
$client_id = "XXX"; // Your API client ID (required)
$client_secret = "YYY"; // Your API client secret (required)
$data = [
'phone' => "11231231234", //Phone number (required)
'groupid' => {ID}, //Group ID (required)
];
curl_setopt($ch, CURLOPT_URL, "$url");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_VERBOSE, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"X-Client-Id: $client_id",
"X-Client-Secret: $client_secret",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
?>
Example request single:
{
"phone": "{nr}",
"groupid": "{ID}",
"firstname": "John",
"lastname": "Doe",
"extra1": "Marketing",
"birthday": "1997-03-23"
}
Example request multiple:
[
{
"phone": "{nr1}",
"groupid": "{ID}",
"firstname": "John",
"lastname": "Doe",
"extra1": "Marketing",
"birthday": "2000-01-01"
},
{
"phone": "{nr2}",
"groupid": "{ID}",
"firstname": "Jane",
"lastname": "Doe",
"extra1": "Marketing",
"birthday": "2000-01-01"
},
]
Example response single:
{
"ID": [ {id} ]
}
Example response multiple:
{
"IDs": [ {id1}, {id2}, ...]
}
Example response multiple with errors:
{
"IDs": [ {id1}, {id2}, ...],
"errors": [
{
"error": 103,
"errorMsg": "Phone number {nr3} is not valid"
},
{
"error": 103,
"errorMsg": "Phone number {nr4} is not valid"
}
]
}
