{"id":13187,"date":"2023-11-15T11:00:28","date_gmt":"2023-11-15T05:00:28","guid":{"rendered":"https:\/\/hostim.themetags.com\/services\/vps-hosting-copy-copy\/"},"modified":"2024-12-24T20:06:19","modified_gmt":"2024-12-24T20:06:19","slug":"api-dev","status":"publish","type":"services","link":"https:\/\/bwatmesaj.com\/en\/services\/api-dev\/","title":{"rendered":"Dev API"},"content":{"rendered":"\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t
<\/div>\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t
<\/div>\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t

Welcome To Bwatmesaj docs
<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

Get familiar with our APIs and technical resources in your favorite languages.<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t

\n\t\t\t\t\t\t
\n\t\t\t
<\/div>\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t

SMS API\u00a0<\/span><\/strong><\/h1>

Bwatmesaj SMS API allows you to send and receive SMS messages to and from any country in the world through a REST API. Each message is identified by a unique random ID so that users can always check the status of a message using the given endpoint.<\/span><\/p>

API Endpoint<\/strong><\/span>
https:\/\/main.bwatmesaj.com\/api\/v3\/sms\/send<\/span><\/p>

Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
Authorization<\/span><\/td>
Yes<\/span><\/div><\/td>
When calling our API, send your api token with the authentication type set as\u00a0Bearer<\/code>\u00a0(Example:\u00a0Authorization: Bearer {api_token}<\/code>)<\/span><\/td><\/tr>
Accept<\/span><\/td>
Yes<\/span><\/div><\/td>
Set to\u00a0application\/json<\/code><\/span><\/td><\/tr><\/tbody><\/table><\/div>
Send outbound SMS<\/span><\/div>

Bwatmesaj’s Programmable SMS API enables you to programmatically send SMS messages from your web application. First, you need to create a new message object. Bwatmesaj returns the created message object with each request.<\/span><\/p>

Send your first SMS message with this example request.<\/span><\/p>

API Endpoint<\/span><\/p>

https:\/\/main.bwatmesaj.com\/api\/v3\/sms\/send<\/span><\/p>

Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
recipient<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Number to send message.\u00a0Use comma (,)<\/code>\u00a0to send multiple numbers. Ex.\u00a031612345678,8801721970168<\/code><\/span><\/td><\/tr>
sender_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters.<\/span><\/td><\/tr>
type<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>The type of the message. For text message you have to insert\u00a0plain<\/code>\u00a0as sms type.<\/span><\/td><\/tr>
message<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>The body of the SMS message.<\/span><\/td><\/tr>
schedule_time<\/span><\/td>
No<\/span><\/div><\/td>
datetime<\/span><\/td>The scheduled date and time of the message in RFC3339 format\u00a0(Y-m-d H:i)<\/code><\/span><\/td><\/tr>
dlt_template_id<\/span><\/td>
No<\/span><\/div><\/td>
string<\/span><\/td>The ID of your registered DLT (Distributed Ledger Technology) content template.<\/span><\/td><\/tr><\/tbody><\/table><\/div>

Example request for Single Number<\/span><\/p>

curl -<\/span>X POST<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/sms\/send \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\\n-<\/span>d '{<\/span>\n\"recipient\"<\/span>:<\/span>\"31612345678\"<\/span>,<\/span>\n\"sender_id\"<\/span>:<\/span>\"YourName\"<\/span>,<\/span>\n\"type\"<\/span>:<\/span>\"plain\"<\/span>,<\/span>\n\"message\"<\/span>:<\/span>\"This is a test message\"<\/span>\n}<\/span>'<\/code><\/span><\/pre>
Example request for Multiple Numbers<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X POST<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/sms\/send \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\\n-<\/span>d '{<\/span>\n\"recipient\"<\/span>:<\/span>\"31612345678,880172145789\"<\/span>,<\/span>\n\"sender_id\"<\/span>:<\/span>\"YourName\"<\/span>,<\/span>\n\"type\"<\/span>:<\/span>\"plain\"<\/span>,<\/span>\n\"message\"<\/span>:<\/span>\"This is a test message\"<\/span>,<\/span>\n\"schedule_time=2021-12-20 07:00\"<\/span>\n}<\/span>'<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"sms reports with all details\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
Send Campaign Using Contact list<\/span><\/div>
Bwatmesaj’s Programmable SMS API enables you to programmatically send Campaigns from your web application. First, you need to create a new message object. Bwatmesaj returns the created message object with each request.<\/span><\/p>
Send your first Campaign Using Contact List with this example request.<\/span><\/p>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/main.bwatmesaj.com\/api\/v3\/sms\/campaign<\/a><\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
contact_list_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact list to send message.\u00a0Use comma (,)<\/code>\u00a0to send multiple contact lists. Ex.\u00a06415907d0d7a6,6415907d0d37a<\/code><\/span><\/td><\/tr>
sender_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters.<\/span><\/td><\/tr>
type<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>The type of the message. For text message you have to insert\u00a0plain<\/code>\u00a0as sms type.<\/span><\/td><\/tr>
message<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>The body of the SMS message.<\/span><\/td><\/tr>
schedule_time<\/span><\/td>
No<\/span><\/div><\/td>
datetime<\/span><\/td>The scheduled date and time of the message in RFC3339 format\u00a0(Y-m-d H:i)<\/code><\/span><\/td><\/tr>
dlt_template_id<\/span><\/td>
No<\/span><\/div><\/td>
string<\/span><\/td>The ID of your registered DLT (Distributed Ledger Technology) content template.<\/span><\/td><\/tr><\/tbody><\/table><\/div>
Example request for Single Contact List<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X POST<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/sms\/campaign \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\\n-<\/span>d '{<\/span>\n\"recipient\"<\/span>:<\/span>\"6415907d0d37a\"<\/span>,<\/span>\n\"sender_id\"<\/span>:<\/span>\"YourName\"<\/span>,<\/span>\n\"type\"<\/span>:<\/span>\"plain\"<\/span>,<\/span>\n\"message\"<\/span>:<\/span>\"This is a test message\"<\/span>\n}<\/span>'<\/code><\/span><\/pre>
Example request for Multiple Contact Lists<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X POST<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/sms\/campaign \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\\n-<\/span>d '{<\/span>\n\"recipient\"<\/span>:<\/span>\"6415907d0d37a,6415907d0d7a6\"<\/span>,<\/span>\n\"sender_id\"<\/span>:<\/span>\"YourName\"<\/span>,<\/span>\n\"type\"<\/span>:<\/span>\"plain\"<\/span>,<\/span>\n\"message\"<\/span>:<\/span>\"This is a test message\"<\/span>,<\/span>\n\"schedule_time=2021-12-20 07:00\"<\/span>\n}<\/span>'<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"campaign reports with all details\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
View an SMS<\/span><\/div>
You can use Bwatmesaj’s SMS API to retrieve information of an existing inbound or outbound SMS message.<\/span><\/p>
You only need to supply the unique message id that was returned upon creation or receiving.<\/span><\/p>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/www.main.bwatmesaj.com\/api\/v3\/sms\/<\/a>{uid}<\/span><\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
uid<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>A unique random uid which is created on the Bwatmesaj platform and is returned upon creation of the object.<\/span><\/td><\/tr><\/tbody><\/table><\/div>
Example request<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X GET<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/sms\/606812e63f78b \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"sms data with all details\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
View all messages<\/span><\/div>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/www.main.bwatmesaj.com\/api\/v3\/sms\/<\/a><\/code><\/span><\/pre>
Example request<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X GET<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/sms \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"sms reports with pagination\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
<\/code><\/span><\/pre>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t
<\/div>\t\t
\n\t\t\t
\n\t\t\t\t\t\t
\n\t\t\t\t
\n\t\t\t\t\t\t\t\t\t
Contacts API<\/span><\/strong><\/h1>
Bwatmesaj Contacts API helps you manage contacts that are identified by a unique random ID. Using this ID, you can create, view, update, or delete contacts. This API works as a collection of customer-specific contacts that allows you to group them and assign custom values that you can later use when sending SMS template messages.<\/span><\/p>
The Contacts API uses HTTP verbs and a RESTful endpoint structure with an access key that is used as the API Authorization. Request and response payloads are formatted as JSON using UTF-8 encoding and URL encoded values.<\/span><\/p>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/main.bwatmesaj.com\/api\/v3\/contacts<\/a><\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
Authorization<\/span><\/td>
Yes<\/span><\/div><\/td>
When calling our API, send your api token with the authentication type set as\u00a0Bearer<\/code>\u00a0(Example:\u00a0Authorization: Bearer {api_token}<\/code>)<\/span><\/td><\/tr>
Accept<\/span><\/td>
Yes<\/span><\/div><\/td>
Set to\u00a0application\/json<\/code><\/span><\/td><\/tr><\/tbody><\/table><\/div>
Create a contact<\/span><\/div>
Creates a new contact object. Bwatmesaj returns the created contact object with each request.<\/span><\/p>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/www.main.bwatmesaj.com\/api\/v3\/contacts\/<\/a>{group_id}<\/span>\/store<\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
group_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact Groups\u00a0uid<\/code><\/span><\/td><\/tr>
PHONE<\/span><\/td>
Yes<\/span><\/div><\/td>
number<\/span><\/td>The phone number of the contact.<\/span><\/td><\/tr>
OTHER_FIELDS<\/span><\/td>
No<\/span><\/div><\/td>
string<\/span><\/td>All Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)<\/span><\/td><\/tr><\/tbody><\/table><\/div>
Example request<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X POST<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/contacts\/6065ecdc9184a\/store \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\\n-<\/span>d '{<\/span>\n\"PHONE\"<\/span>:<\/span>\"8801721970168\"<\/span>,<\/span>\n\"FIRST_NAME\"<\/span>:<\/span>\"Jhon\"<\/span>,<\/span>\n\"LAST_NAME\"<\/span>:<\/span>\"Doe\"<\/span>,<\/span>\n}<\/span>'<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"contacts data with all details\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
View a contact<\/span><\/div>
Retrieves the information of an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation or receiving.<\/span><\/p>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/www.main.bwatmesaj.com\/api\/v3\/contacts\/<\/a>{group_id}<\/span>\/search\/{uid}<\/span><\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
group_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact Groups\u00a0uid<\/code><\/span><\/td><\/tr>
uid<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact\u00a0uid<\/code><\/span><\/td><\/tr><\/tbody><\/table><\/div>
Example request<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X POST<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/contacts\/6065ecdc9184a\/search\/606732aec8705 \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"contacts data with all details\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
Update a contact<\/span><\/div>
Updates an existing contact. You only need to supply the unique uid of contact and contact group uid that was returned upon creation.<\/span><\/p>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/www.main.bwatmesaj.com\/api\/v3\/contacts\/<\/a>{group_id}<\/span>\/update\/{uid}<\/span><\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
group_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact Groups\u00a0uid<\/code><\/span><\/td><\/tr>
uid<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact\u00a0uid<\/code><\/span><\/td><\/tr>
PHONE<\/span><\/td>
Yes<\/span><\/div><\/td>
number<\/span><\/td>The phone number of the contact.<\/span><\/td><\/tr>
OTHER_FIELDS<\/span><\/td>
No<\/span><\/div><\/td>
string<\/span><\/td>All Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)<\/span><\/td><\/tr><\/tbody><\/table><\/div>
Example request<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X PATCH<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/contacts\/6065ecdc9184a\/update\/606732aec8705 \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\\n-<\/span>d '{<\/span>\n\"PHONE\"<\/span>:<\/span>\"8801721970168\"<\/span>,<\/span>\n\"FIRST_NAME\"<\/span>:<\/span>\"Jhon\"<\/span>,<\/span>\n\"LAST_NAME\"<\/span>:<\/span>\"Doe\"<\/span>,<\/span>\n}<\/span>'<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"contacts data with all details\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
Delete a contact<\/span><\/div>
Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.<\/span><\/p>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/www.main.bwatmesaj.com\/api\/v3\/contacts\/<\/a>{group_id}<\/span>\/delete\/{uid}<\/span><\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
group_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact Groups\u00a0uid<\/code><\/span><\/td><\/tr>
uid<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact\u00a0uid<\/code><\/span><\/td><\/tr><\/tbody><\/table><\/div>
Example request<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X DELETE<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/contacts\/6065ecdc9184a\/delete\/606732aec8705 \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"contacts data with all details\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>
View all contacts in group<\/span><\/div>
API Endpoint<\/span><\/p>
Markup<\/span><\/div><\/div>
https:\/\/www.main.bwatmesaj.com\/api\/v3\/contacts\/<\/a>{group_id}<\/span>\/all<\/code><\/span><\/pre>
Parameters<\/span><\/div>
Parameter<\/span><\/th>Required<\/span><\/th>Type<\/span><\/th>Description<\/span><\/th><\/tr><\/thead>
group_id<\/span><\/td>
Yes<\/span><\/div><\/td>
string<\/span><\/td>Contact Groups\u00a0uid<\/code><\/span><\/td><\/tr><\/tbody><\/table><\/div>
Example request<\/span><\/div>
PHP<\/span><\/div><\/div>
curl -<\/span>X POST<\/span> https:<\/span>\/\/main.bwatmesaj.com\/api\/v3\/contacts\/6065ecdc9184a\/all \\<\/span>\n-<\/span>H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca'<\/span> \\\n-<\/span>H 'Content-Type: application\/json'<\/span> \\\n-<\/span>H 'Accept: application\/json'<\/span> \\<\/code><\/span><\/pre>
Returns<\/span><\/div>
Returns a contact object if the request was successful.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"success\"<\/span>,<\/span>\n    \"data\"<\/span>:<\/span> \"contacts data with pagination\"<\/span>,<\/span>\n}<\/span><\/code><\/span><\/pre>
If the request failed, an error object will be returned.<\/span><\/p>
JSON<\/span><\/div><\/div>
{<\/span>\n    \"status\"<\/span>:<\/span> \"error\"<\/span>,<\/span>\n    \"message\"<\/span> :<\/span> \"A human-readable description of the error.\"<\/span>\n}<\/span><\/code><\/span><\/pre>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t\t<\/div>\n\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t<\/section>\n\t\t\t\t<\/div>\n\t\t","protected":false},"featured_media":0,"comment_status":"open","ping_status":"closed","template":"elementor_header_footer","services_cat":[25],"class_list":["post-13187","services","type-services","status-publish","hentry","services_cat-wordpress-hosting"],"_links":{"self":[{"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/services\/13187","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/services"}],"about":[{"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/types\/services"}],"replies":[{"embeddable":true,"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/comments?post=13187"}],"version-history":[{"count":15,"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/services\/13187\/revisions"}],"predecessor-version":[{"id":17919,"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/services\/13187\/revisions\/17919"}],"wp:attachment":[{"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/media?parent=13187"}],"wp:term":[{"taxonomy":"services_cat","embeddable":true,"href":"https:\/\/bwatmesaj.com\/en\/wp-json\/wp\/v2\/services_cat?post=13187"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}