Read Contact
Read Contact for SMSGatewayCenter APIs
Introduction to SMSGatewayCenter APIs
Welcome to SMSGatewayCenter’s API documentation hub! This guide enables you to retrieve your contact list, including group names, using our flexible Read Contact API, a vital component of our messaging suite, including SMS API for bulk messaging, WhatsApp Business API for customer engagement, Voice Call API for automated alerts, and Two-Way SMS API for interactive communication. This API supports both POST and GET methods over HTTP, ensuring secure and adaptable access to your contacts. Designed for developers in India, explore our SMS gateway at unify.smsgateway.center/signup/!
Fetch your contacts with associated group names (e.g., for campaign planning) effortlessly with the Read Contact API. This endpoint optimizes your bulk SMS operations by providing real-time contact data, enhancing targeting efficiency.
API Endpoint
https://unify.smsgateway.center/SMSApi/contact/read
| Key | Value | Description |
|---|---|---|
| Login Credentials (Required) | ||
| Authenticate your API request using userid-password or apiKey—choose one method. | ||
| userid | Your Registered Username | Your registered username; use if apiKey isn’t provided. Signup for User ID |
| password | Your Password | URL-encoded password (for special characters); use if apiKey isn’t provided. Signup for API Key |
| Header (optional) Parameters | ||
| apiKey | Your unique apiKey | apiKey needs to be sent as HTTP header when you are not using userid-password method. You can avail this from your user control panel and use instead of userid-password HTTP Request parameter. Please do not disclose this to anyone. |
| output | plain|json|plain | Value for response format.System default is plain. If you need responses in json or plain then you have to give value as json or plain. |
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://unify.smsgateway.center/SMSApi/contact/read",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "userid=YourUsername&password=YourPassword&output=json",
CURLOPT_HTTPHEADER => array(
"cache-control: no-cache",
"content-type: application/x-www-form-urlencoded"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"response": {
"api": "contact",
"action": "read",
"status": "success",
"msg": "success",
"code": "200",
"count": 2,
"contactList": [
{
"contact": {
"cId": "144441",
"contactName": "abcd",
"contactStatus": "1",
"groupId": "63",
"mobileNo": "919999999999",
"groupName": "TEST4567",
"groupType": "PHONEBOOK"
}
},
{
"contact": {
"cId": "23347200",
"contactName": "Test Name",
"contactStatus": "1",
"groupId": "63",
"mobileNo": "911232987678",
"groupName": "TEST4567",
"groupType": "PHONEBOOK"
}
}
]
}
}
Unlock Real-Time Messaging – Integrate Today!
Try Our API in a Sandbox Environment Before Going Live!
Join Thousands of Developers – Try Our API Now!
Get in touchSign upTestimonials
Why do Great Businesses Trust SMS Gateway Center?