Introduction
Desk360 API is a Representational State Transfer (REST ) structure that provides operations such as:
Reading
Modifying
Adding data
Deleting data
from your help desk.
Desk360 APIs also support Cross-Origin Resource Sharing (CORS ).
HTTP Methods
The list of API commands used by Desk360
Updates/Modifies an object
All API requests must reach the secure endpoint i.e. HTTPS only
Rate Limit
This rate limit applies are based on IP address.
Make sure to apply the rate limit-best practices and it stays within the rate limit.
Make sure to make API calls in a safe layer such as your backend, not front-end or your mobile application .
Remind that even invalid requests are included in the rate limit.
Check your current rate limit status by looking at the following HTTP headers returned in response to each API request:
Copy HTTP / 1.1 200 OK
Content-Type : application/json
X-RateLimit-Limit : 60
X-RateLimit-Remaining : 58
Total number of API calls allowed per minute.
The number of requests remaining in the current rate limit window.
The reset time in Unix epoch time format.
The number of seconds you should wait in order to trigger your next API request.
This header is returned only when the rate limit is reached.
If your API request is received after the rate limit is reached, Desk360 will return an error in the response. The Retry-After value in the response header will tell you how long to wait before sending another API request.
Copy HTTP / 1.1 200 OK
Content-Type : application/json
Retry-After : 26
Who can access my helpdesk? Can anyone see my data?
Before prioritizing a ticket or responding to a customer or using any of the APIs listed above, you must authenticate or log in as you sign in to your helpdesk web portal.
To authenticate the request, you can use your personal. You can obtain your API token with a request with your username and password .
All Desk360 API endpoints (except login) need this token in order to respond to your request.
Obtain your token with a request.
You can directly use v1/login endpoint in order to create/obtain an API token. This API will return an auto-generate a token and returns it.
To make it secure, the maximum wrong login attempt is fixed to 5 per minute .
Correct attempts do not affect the limits.
Login
POST
https://public-api.desk360.com/v1/login
Use a valid email and password pair to obtain a token.
Request Body
An email that is already registered
200 Your API access token return as "token"
Copy {
"access_token" : "1|iybflVqHloQdz9QH4PIkX0q1Od68T9sDrKCtnuxW6f78ad5b" ,
"token_type" : "Bearer"
}
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/login' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "abc@example.com",
"password": "YOUR_PASSWORD"
}'
Copy var client = new RestClient ( "https://public-api.desk360.com/v1/login" );
client . Timeout = - 1 ;
var request = new RestRequest ( Method . POST );
request .AddHeader( "Content-Type" , "application/json" );
request .AddParameter( "application/json" , "{\n \"email\": \"abc@example.com\",\n \"password\": \"YOUR_PASSWORD\"\n}" , ParameterType . RequestBody );
IRestResponse response = client .Execute(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "application/json" );
RequestBody body = RequestBody . create (mediaType , "{\n \"email\": \"abc@example.com\",\n \"password\": \"YOUR_PASSWORD\"\n}" );
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/login" )
. method ( "POST" , body)
. addHeader ( "Content-Type" , "application/json" )
. build ();
Response response = client . newCall (request) . execute ();
Copy var axios = require ( 'axios' );
var data = JSON .stringify ({ "email" : "abc@example.com" , "password" : "YOUR_PASSWORD" });
var config = {
method : 'post' ,
url : 'https://public-api.desk360.com/v1/login' ,
headers : {
'Content-Type' : 'application/json'
} ,
data : data
};
axios (config)
.then ( function (response) {
console .log ( JSON .stringify ( response .data));
})
.catch ( function (error) {
console .log (error);
});
Copy <? php
$client = new http \ Client ;
$request = new http \ Client \ Request ;
$request -> setRequestUrl ( 'https://public-api.desk360.com/v1/login' ) ;
$request -> setRequestMethod ( 'POST' ) ;
$body = new http \ Message \ Body ;
$body -> append ( '{
"email": "abc@example.com",
"password": "YOUR_PASSWORD"
}' ) ;
$request -> setBody ( $body ) ;
$request -> setOptions ( array () ) ;
$request -> setHeaders ( array (
'Content-Type' => 'application/json'
) ) ;
$client -> enqueue ( $request ) -> send () ;
$response = $client -> getResponse () ;
echo $response -> getBody () ;
Copy import requests
url = "https://public-api.desk360.com/v1/login"
payload = "{\n \"email\": \"abc@example.com\",\n \"password\": \"YOUR_PASSWORD\"\n}"
headers = {
'Content-Type' : 'application/json'
}
response = requests . request ( "POST" , url, headers = headers, data = payload)
print (response.text)
The following endpoints are supported with attachments:
Please follow the guidelines listed below:
Only files on a local machine can be added using the API. You can not use links!
Content-Type should always be multi-part/form-data for attached requests.
I received an error. How can I solve it?
API requests that cause errors will return an appropriate HTTP status code to help determine the type of error. You can use the following table to understand what each code means:
Client or Validation Error
The request body/query string is not in the correct format.
For example, the Send a message API requires the to field to be submitted as part of the request, and if it is missing, this status code is returned.
This indicates that the Authorization field is either missing or incorrect.
Requested Resource not Found
The request contains an invalid ID or invalid parameters in the URL .
For example, an API call to retrieve a integration with an invalid ID will return an HTTP 404 status code to inform you that no such integration exists.
This API request has used the wrong HTTP method.
For example, a DELETE requested on /integrations endpoint will return an HTTP 405 as /integrations allows only GET requests.
Unsupported Accept Header
Only application/json and */* are supported. When uploading files multipart/form-data are supported.
Only application/json is supported.
Sample error response
In addition to the HTTP status code, most errors also return a response with more information to help you troubleshoot the error. An example error response is shown below. The format of the error response is explained after the example.
Copy "error": {
"code" : "failed_validation" ,
"message" : "The to field is required."
"doc_url" : "https://docs.desk360.com/api"
}
}
Error Response Fields
Custom error code that is machine-parseable.
Descriptive error message.
A link to guide you if there is a solution on the documentation.
Error Codes
Authentication failed. The token is missing or invalid. Do not forget to put "Bearer " in the beginning of your token. eg: "Bearer YOUR-API-TOKEN "
method_not_allowed_exception
You may have made a typo in your request URL.
model_not_found_exception
Requested resource not found, the resource maybe deleted or maybe the resource is not yours.
insecure_request_exception
HTTP is not allowed. Use HTTPS instead.
too_many_requests_exception
You typed your email/password wrong.
If you entered your email/password wrong more than 5 times, you should wait for a minute.
You do not have permission to modify the resource.
Requested resource not found, the resource maybe deleted or maybe the resource is not yours.
This is a validation error, please read the message and apply what it says.
API responses that return a list of objects are paginated, for example, View Integration List . Add the parameter page to the query string to navigate through the pages. The page number starts from 1 and each page is fixed to show 20 objects.
Copy https://public-api.desk360.com/api/v1/integrations?page=1
The "Link" header in the response will be showing the next page if it exists:
Copy Headers
"Link" : <https://public-api.desk360.com/v1/integrations?page=2>; rel=next
If you are on the last page the link header will not be filled.
Whenever it is possible, please queue API calls on your side. This allows you to buffer recent calls to avoid reaching the rate limit. Once you reach the rate limit, retry API calls after the retry period.
Whenever it is feasible, cache the data that does not change much on your side. For example, the mapping between agent name and ID is extremely unlikely to change, so it is a useful approach to cache this data to avoid the rate limit.
Avoid making API calls directly from a mobile app, instead, send the request to your servers and make API calls from there. This ensures that if an API endpoint is changed, you can make and deploy the change on your server instead of updating your application and forcing your customers to the latest version.
Integrations
Apart from its competitors, Desk360 enables its customers to manage multiple integrations under one account.
In order to find your Integration ID , visit Integrations .
Integrations
GET
https://public-api.desk360.com/v1/integrations
List of your integrations.
200
Copy [
{
"id" : 11 ,
"display_name" : "YourIntegration1" ,
"phone_number" : "+905554443322"
} ,
{
"id" : 22 ,
"name" : "YourIntegration2" ,
"logo" : "+905555555555"
}
]
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request GET 'https://public-api.desk360.com/v1/integrations' \
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copy var client = new RestClient ( "https://public-api.desk360.com/v1/integrations" );
client . Timeout = - 1 ;
var request = new RestRequest ( Method . GET );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
IRestResponse response = client .Execute(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations" )
. method ( "GET" , null )
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy var axios = require ( 'axios' );
var config = {
method : 'get' ,
url : 'https://public-api.desk360.com/v1/integrations' ,
headers : {
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
};
axios (config)
.then ( function (response) {
console .log ( JSON .stringify ( response .data));
})
.catch ( function (error) {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'GET' ,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations"
payload = {}
headers = {
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "GET" , url, headers = headers, data = payload)
print (response.text)
WhatsApp Message Templates
WhatsApp message templates are message formats that let you deliver multiple notifications to customers who have agreed to receive them via WhatsApp.
WhatsApp Message Templates
GET
https://public-api.desk360.comv1/integrations/:integrationId/conversations/templates
Get WhatsApp message template and languages list from a product.
Path Parameters
The ID of your integration
200
Copy [
{
"id" : 75 ,
"name" : "template_02" ,
"category_editable" : false ,
"sendable" : true ,
"category" : {
"value" : 2 ,
"label" : "template-messages.new.custom" ,
"subLabel" : "template-messages.new.custom-subtitle" ,
"status" : 1 ,
"children" : []
} ,
"category_label" : "template-messages.new.custom" ,
"supported_languages" : [
{
"label" : "English" ,
"value" : 1 ,
"filled" : true
} ,
{
"label" : "Türkçe" ,
"value" : 2 ,
"filled" : true
}
] ,
"translations" : [
{
"language_id" : 1 ,
"language" : "English" ,
"header_type" : null ,
"header_variables" : null ,
"header" : null ,
"header_file" : null ,
"body" : "English content test" ,
"body_variables" : null ,
"footer" : null ,
"variables" : [] ,
"buttons" : [] ,
"editable" : true ,
"status" : "template-messages.in-review" ,
"status_value" : 1 ,
"quality" : "template-messages.quality-unavailable" ,
"updated_at" : "2024-05-31T06:33:30.000000Z"
} ,
{
"language_id" : 2 ,
"language" : "Türkçe" ,
"header_type" : {
"value" : 4 ,
"label" : "TEXT"
} ,
"header_variables" : [
{
"id" : "" ,
"key" : "1" ,
"value" : "Header 1"
}
] ,
"header" : "Merhaba {{1}} ," ,
"header_file" : null ,
"body" : "Merhaba {{1}}, Sipariş takip numaranız: {{2}} Bu takip numarası ile siparişinizin durumunu sorgulayabilirsiniz." ,
"body_variables" : [
{
"id" : "" ,
"key" : "1" ,
"value" : "Ahmet Kara"
} ,
{
"id" : "" ,
"key" : "2" ,
"value" : "SP123456789"
}
] ,
"footer" : null ,
"variables" : [
"header-1" ,
"body-1" ,
"body-2"
] ,
"buttons" : [] ,
"editable" : true ,
"status" : "template-messages.active" ,
"status_value" : 2 ,
"quality" : "template-messages.quality-unavailable" ,
"updated_at" : "2024-05-30T12:16:37.000000Z"
}
] ,
"created_at" : "2024-05-30T12:14:28.000000Z" ,
"updated_at" : "2024-05-31T06:33:30.000000Z"
}
]
Code Samples
cURL C# Java Javascript PHP Python
Copy curl --location --request GET 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/?page=1' \- -header 'Authorization: Bearer YOUR_API_TOKEN'
Copy var client = new RestClientRestClient ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates" );
client . Timeout = - 1 ;
var request = new RestRequest ( Method . GET );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
IRestResponse response = client .Execute(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates" )
. method ( "GET" , null )
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy var axios = require ( 'axios' );
var config = {
method : 'get' ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates' ,
headers : {
'Authorization' : 'Bearer YOUR_API_TOKEN' ,
}
};
axios (config)
.then ( function (response) {
console .log ( JSON .stringify ( response .data));
})
.catch ( function (error) {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'GET' ,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer YOUR_API_TOKEN' ,
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates"
payload = {}
headers = {
'Authorization' : 'Bearer YOUR_API_TOKEN' ,
}
response = requests . request ( "GET" , url, headers = headers, data = payload)
print (response.text)
Send WhatsApp Message Template
POST
https://public-api.desk360.com/v1/integrations/:integrationsId/conversations/templates/send
Send active WhatsApp message template to a WhatsApp number. If you send with attachments, use form-data. You can also send other body parameters with form-data as well.
Path Parameters
The ID of your integration
Request Body
The template id of the template to be sent.
The language id of the template to be sent.
Required parameters for the template. The key list received in the template list should be used as a key during submission.
WhatsApp number to be sent. It should start with (+) and a country code.
destinations.*.parameters
Required parameters for the template. The key list received in the template list should be used as a key during submission.
Attachment for the message template (only allowed in form-data).
200
Copy {
"message_id" : "gBEGkFBXUQRnAglW0luHY8xsrFk"
}
Code Samples
cURL C# Java Javascript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send' \
--header 'Authorization: YOUR_API_TOKEN' \
--form 'template_id="1"' \
--form 'language_id="1"' \
--form 'destinations[0][phone]="+905555555555"' \
--form 'destinations[0][parameters][header-1]="Header 1"' \
--form 'destinations[0][parameters][body-1]="Body 1"' \
--form 'destinations[0][parameters][body-2]="Body 2"' \
--form 'attachment=@"/test_image.jpg"'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/integrationId/conversations/templates/send" , Method . Post );
request .AddHeader( "Authorization" , "YOUR_API_TOKEN" );
request . AlwaysMultipartFormData = true ;
request .AddParameter( "template_id" , "1" );
request .AddParameter( "language_id" , "1" );
request .AddParameter( "destinations[0][phone]" , "+905555555555" );
request .AddParameter( "destinations[0][parameters][header-1]" , "Header 1" );
request .AddParameter( "destinations[0][parameters][body-1]" , "Body 1" );
request .AddParameter( "destinations[0][parameters][body-2]" , "Body 2" );
request .AddFile( "attachment" , "/test_image.jpg" );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "text/plain" );
RequestBody body = new MultipartBody . Builder () . setType ( MultipartBody . FORM )
. addFormDataPart ( "template_id" , "1" )
. addFormDataPart ( "language_id" , "1" )
. addFormDataPart ( "destinations[0][phone]" , "+905555555555" )
. addFormDataPart ( "destinations[0][parameters][header-1]" , "Header 1" )
. addFormDataPart ( "destinations[0][parameters][body-1]" , "Body 1" )
. addFormDataPart ( "destinations[0][parameters][body-2]" , "Body 2" )
. addFormDataPart ( "attachment" , "test_image.jpg" ,
RequestBody . create ( MediaType . parse ( "application/octet-stream" ) ,
new File( "/test_image.jpg" ) ))
. build ();
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send" )
. method ( "POST" , body)
. addHeader ( "Authorization" , "YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
const FormData = require ( 'form-data' );
const fs = require ( 'fs' );
let data = new FormData ();
data .append ( 'template_id' , '1' );
data .append ( 'language_id' , '1' );
data .append ( 'destinations[0][phone]' , '+905555555555' );
data .append ( 'destinations[0][parameters][header-1]' , 'Header 1' );
data .append ( 'destinations[0][parameters][body-1]' , 'Body 1' );
data .append ( 'destinations[0][parameters][body-2]' , 'Body 2' );
data .append ( 'attachment' , fs .createReadStream ( '/test_image.jpg' ));
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send' ,
headers : {
'Authorization' : 'YOUR_API_TOKEN' ,
... data .getHeaders ()
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => array( 'template_id' => '1' , 'language_id' => '1' , 'destinations[0][phone]' => '+905555555555' , 'destinations[0][parameters][header-1]' => 'Header 1' , 'destinations[0][parameters][body-1]' => 'Body 1' , 'destinations[0][parameters][body-2]' => 'Body 2' , 'attachment' => new CURLFILE ( '/test_image.jpg' )) ,
CURLOPT_HTTPHEADER => array(
'Authorization: YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send"
payload = { 'template_id' : '1' ,
'language_id' : '1' ,
'destinations[0][phone]' : '+905555555555' ,
'destinations[0][parameters][header-1]' : 'Header 1' ,
'destinations[0][parameters][body-1]' : 'Body 1' ,
'destinations[0][parameters][body-2]' : 'Body 2' }
files = [
( 'attachment' , ( 'test_image.jpg' , open ( '/test_image.jpg' , 'rb' ), 'image/png' ))
]
headers = {
'Authorization' : 'YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload, files = files)
print (response.text)
Bulk Send WhatsApp Message Template
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send/bulk
Send active WhatsApp message template to multiple WhatsApp number. If you send with attachments, use form-data. You can also send other body parameters with form-data as well.
Path Parameters
The ID of your integration
Request Body
The template id of the template to be sent.
The language id of the template to be sent.
Destinations for the template.
WhatsApp number to be sent. It should start with (+) and a country code.
Required parameters for the template. The key list received in the template list should be used as a key during submission.
Attachment for the message template (only allowed in form-data).
WhatsApp numbers csv file to be sent. It should start with (+) and a country code.
200
Copy {
"phones" : [
"+905555555555"
]
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send/bulk' \
--header 'Authorization: YOUR_API_TOKEN' \
--form 'template_id="1"' \
--form 'language_id="1"' \
--form 'destinations[0][phone]="+905555555555"' \
--form 'parameters[header-1]="Header 1"' \
--form 'parameters[body-1]="Body 1"' \
--form 'parameters[body-2]="Body 2"' \
--form 'attachment=@"/test_image.jpg"'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/templates/send/bulk" , Method . Post );
request .AddHeader( "Authorization" , "YOUR_API_TOKEN" );
request . AlwaysMultipartFormData = true ;
request .AddParameter( "template_id" , "1" );
request .AddParameter( "language_id" , "1" );
request .AddParameter( "destinations[0][phone]" , "+905555555555" );
request .AddParameter( "parameters[header-1]" , "Header 1" );
request .AddParameter( "parameters[body-1]" , "Body 1" );
request .AddParameter( "parameters[body-2]" , "Body 2" );
request .AddFile( "attachment" , "/test_image.jpg" );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "text/plain" );
RequestBody body = new MultipartBody . Builder () . setType ( MultipartBody . FORM )
. addFormDataPart ( "template_id" , "1" )
. addFormDataPart ( "language_id" , "1" )
. addFormDataPart ( "destinations[0][phone]" , "+905555555555" )
. addFormDataPart ( "parameters[header-1]" , "Header 1" )
. addFormDataPart ( "parameters[body-1]" , "Body 1" )
. addFormDataPart ( "parameters[body-2]" , "Body 2" )
. addFormDataPart ( "attachment" , "test_image.jpg" ,
RequestBody . create ( MediaType . parse ( "application/octet-stream" ) ,
new File( "/test_image.jpg" ) ))
. build ();
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send/bulk" )
. method ( "POST" , body)
. addHeader ( "Authorization" , "YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
const FormData = require ( 'form-data' );
const fs = require ( 'fs' );
let data = new FormData ();
data .append ( 'template_id' , '1' );
data .append ( 'language_id' , '1' );
data .append ( 'destinations[0][phone]' , '+905555555555' );
data .append ( 'parameters[header-1]' , 'Header 1' );
data .append ( 'parameters[body-1]' , 'Body 1' );
data .append ( 'parameters[body-2]' , 'Body 2' );
data .append ( 'attachment' , fs .createReadStream ( '/test_image.jpg' ));
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send/bulk' ,
headers : {
'Authorization' : 'YOUR_API_TOKEN' ,
... data .getHeaders ()
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send/bulk' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => array( 'template_id' => '1' , 'language_id' => '1' , 'destinations[0][phone]' => '+905555555555' , 'parameters[header-1]' => 'Header 1' , 'parameters[body-1]' => 'Body 1' , 'parameters[body-2]' => 'Body 2' , 'attachment' => new CURLFILE ( '/test_image.jpg' )) ,
CURLOPT_HTTPHEADER => array(
'Authorization: YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/templates/send/bulk"
payload = { 'template_id' : '1' ,
'language_id' : '1' ,
'destinations[0][phone]' : '+905555555555' ,
'parameters[header-1]' : 'Header 1' ,
'parameters[body-1]' : 'Body 1' ,
'parameters[body-2]' : 'Body 2' }
files = [
( 'attachment' , ( 'desk360_facebook.png' , open ( '/test_image.jpg' , 'rb' ), 'image/png' ))
]
headers = {
'Authorization' : 'YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload, files = files)
print (response.text)
WhatsApp Messages
Use the messages node to send text, location, contact, media, interactive, location request and read receipt message to your customers.
Send WhatsApp Message
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages
Send message to an active WhatsApp number.
Path Parameters
The ID of your integration
Request Body
WhatsApp number to be sent. It should start with (+) and a country code.
Message body. It should max 4096 chars.
200
Copy {
"message_id" : "gBEGkFBXUQRnAgnoOJ1ESPKBwME"
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--form 'to="+90xxxxxxxxxx"' \
--form 'text="Hello!"'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages" , Method . Post );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
request . AlwaysMultipartFormData = true ;
request .AddParameter( "to" , "+90xxxxxxxxxx" );
request .AddParameter( "text" , "Hello!" );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "text/plain" );
RequestBody body = new MultipartBody . Builder () . setType ( MultipartBody . FORM )
. addFormDataPart ( "to" , "+90xxxxxxxxxx" )
. addFormDataPart ( "text" , "Hello!" )
. build ();
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages" )
. method ( "POST" , body)
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
const FormData = require ( 'form-data' );
let data = new FormData ();
data .append ( 'to' , '+90xxxxxxxxxx' );
data .append ( 'text' , 'hello!' );
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages' ,
headers : {
'Authorization' : 'Bearer YOUR_API_TOKEN' ,
... data .getHeaders ()
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => array( 'to' => '+90xxxxxxxxxx' , 'text' => 'Hello!' ) ,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages"
payload = { 'to' : '+90xxxxxxxxxx' ,
'text' : 'Hello!' }
files = [
]
headers = {
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload, files = files)
print (response.text)
Send WhatsApp Location Message
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages
Send location message to an active WhatsApp number.
Path Parameters
The ID of your integration
Request Body
WhatsApp number to be sent. It should start with (+) and a country code.
An object of the message.
200
Copy {
"message_id" : "gBEGkFBXUQRnAgn3kXajlucbaso"
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/locations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data '{
"to": "+90xxxxxxxxxx",
"location": {
"longitude": -122.425332,
"latitude": 37.758056,
"name": "Facebook HQ",
"address": "1 Hacker Way, Menlo Park, CA 94025"
}
}'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages/locations" , Method . Post );
request .AddHeader( "Content-Type" , "application/json" );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
var body = @"{" + "\n" +
@" ""to"": ""+90xxxxxxxxxx""," + "\n" +
@" ""location"": {" + "\n" +
@" ""longitude"": -122.425332," + "\n" +
@" ""latitude"": 37.758056," + "\n" +
@" ""name"": ""Facebook HQ""," + "\n" +
@" ""address"": ""1 Hacker Way, Menlo Park, CA 94025""" + "\n" +
@" }" + "\n" +
@"}" ;
request .AddStringBody(body , DataFormat . Json );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "application/json" );
RequestBody body = RequestBody . create (mediaType , "{\n \"to\": \"+90xxxxxxxxxx\",\n \"location\": {\n \"longitude\": -122.425332,\n \"latitude\": 37.758056,\n \"name\": \"Facebook HQ\",\n \"address\": \"1 Hacker Way, Menlo Park, CA 94025\"\n }\n}" );
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/locations" )
. method ( "POST" , body)
. addHeader ( "Content-Type" , "application/json" )
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
let data = JSON .stringify ({
"to" : "+90xxxxxxxxxx" ,
"location" : {
"longitude" : - 122.425332 ,
"latitude" : 37.758056 ,
"name" : "Facebook HQ" ,
"address" : "1 Hacker Way, Menlo Park, CA 94025"
}
});
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/locations' ,
headers : {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/locations' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => '{
"to": "+90xxxxxxxxxx",
"location": {
"longitude": -122.425332,
"latitude": 37.758056,
"name": "Facebook HQ",
"address": "1 Hacker Way, Menlo Park, CA 94025"
}
}' ,
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json' ,
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
import json
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/locations"
payload = json . dumps ({
"to" : "+90xxxxxxxxxx" ,
"location" : {
"longitude" : - 122.425332 ,
"latitude" : 37.758056 ,
"name" : "Facebook HQ" ,
"address" : "1 Hacker Way, Menlo Park, CA 94025"
}
})
headers = {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload)
print (response.text)
Send WhatsApp Contact Message
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/contacts
Send contact message to an active WhatsApp number.
Path Parameters
The ID of your integration
Request Body
WhatsApp number to be sent. It should start with (+) and a country code.
contacts.*.addresses.*.street
contacts.*.addresses.*.city
contacts.*.addresses.*.state
contacts.*.addresses.*.zip
contacts.*.addresses.*.country
contacts.*.addresses.*.country_code
contacts.*.addresses.*.type
Birtday of contacts. Must be "Y-m-d" format.
contacts.*.emails.*.email
contacts.*.name.formatted_name*
Formatted name of name object.
contacts.*.name.first_name*
First name of name object.
contacts.*.name.last_name*
Last name of name object.
contacts.*.name.middle_name
Middle name of name object.
Company name of organization.
contacts.*.org.department
Department of organization.
contacts.*.phones.*.phone
contacts.*.phones.*.wa_id
200
Copy {
"message_id" : "gBEGkFBXUQRnAgkCL1xSaIMoDz0"
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/contacts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data-raw '{
"to": "+90xxxxxxxxxx",
"contacts": [
{
"addresses": [
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "1 Hacker Way",
"type": "HOME",
"zip": "94025"
}
],
"birthday": "2012-08-18",
"emails": [
{
"email": "test@whatsapp.com",
"type": "WORK"
}
],
"name": {
"first_name": "John",
"formatted_name": "John Smith",
"last_name": "Smith"
},
"org": {
"company": "WhatsApp",
"department": "Design",
"title": "Manager"
},
"phones": [
{
"phone": "+1 (650) 555-1234",
"type": "WORK",
"wa_id": "16505551234"
}
],
"urls": [
{
"url": "https://www.facebook.com",
"type": "WORK"
}
]
}
]
}'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages/contacts" , Method . Post );
request .AddHeader( "Content-Type" , "application/json" );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
var body = @"{" + "\n" +
@" ""to"": ""+90xxxxxxxxxx""," + "\n" +
@" ""contacts"": [" + "\n" +
@" {" + "\n" +
@" ""addresses"": [" + "\n" +
@" {" + "\n" +
@" ""city"": ""Menlo Park""," + "\n" +
@" ""country"": ""United States""," + "\n" +
@" ""country_code"": ""us""," + "\n" +
@" ""state"": ""CA""," + "\n" +
@" ""street"": ""1 Hacker Way""," + "\n" +
@" ""type"": ""HOME""," + "\n" +
@" ""zip"": ""94025""" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""birthday"": ""2012-08-18""," + "\n" +
@" ""emails"": [" + "\n" +
@" {" + "\n" +
@" ""email"": ""test@whatsapp.com""," + "\n" +
@" ""type"": ""WORK""" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""name"": {" + "\n" +
@" ""first_name"": ""John""," + "\n" +
@" ""formatted_name"": ""John Smith""," + "\n" +
@" ""last_name"": ""Smith""" + "\n" +
@" }," + "\n" +
@" ""org"": {" + "\n" +
@" ""company"": ""WhatsApp""," + "\n" +
@" ""department"": ""Design""," + "\n" +
@" ""title"": ""Manager""" + "\n" +
@" }," + "\n" +
@" ""phones"": [" + "\n" +
@" {" + "\n" +
@" ""phone"": ""+1 (650) 555-1234""," + "\n" +
@" ""type"": ""WORK""," + "\n" +
@" ""wa_id"": ""16505551234""" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""urls"": [" + "\n" +
@" {" + "\n" +
@" ""url"": ""https://www.facebook.com""," + "\n" +
@" ""type"": ""WORK""" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@"}" ;
request .AddStringBody(body , DataFormat . Json );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "application/json" );
RequestBody body = RequestBody.create(mediaType, "{\n \"to\": \"+90xxxxxxxxxx\",\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"Menlo Park\",\n \"country\": \"United States\",\n \"country_code\": \"us\",\n \"state\": \"CA\",\n \"street\": \"1 Hacker Way\",\n \"type\": \"HOME\",\n \"zip\": \"94025\"\n }\n ],\n \"birthday\": \"2012-08-18\",\n \"emails\": [\n {\n \"email\": \"test@whatsapp.com\",\n \"type\": \"WORK\"\n }\n ],\n \"name\": {\n \"first_name\": \"John\",\n \"formatted_name\": \"John Smith\",\n \"last_name\": \"Smith\"\n },\n \"org\": {\n \"company\": \"WhatsApp\",\n \"department\": \"Design\",\n \"title\": \"Manager\"\n },\n \"phones\": [\n {\n \"phone\": \"+1 (650) 555-1234\",\n \"type\": \"WORK\",\n \"wa_id\": \"16505551234\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"https://www.facebook.com\",\n \"type\": \"WORK\"\n }\n ]\n }\n ]\n}");
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/contacts" )
. method ( "POST" , body)
. addHeader ( "Content-Type" , "application/json" )
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
let data = JSON .stringify ({
"to" : "+90xxxxxxxxxx" ,
"contacts" : [
{
"addresses" : [
{
"city" : "Menlo Park" ,
"country" : "United States" ,
"country_code" : "us" ,
"state" : "CA" ,
"street" : "1 Hacker Way" ,
"type" : "HOME" ,
"zip" : "94025"
}
] ,
"birthday" : "2012-08-18" ,
"emails" : [
{
"email" : "test@whatsapp.com" ,
"type" : "WORK"
}
] ,
"name" : {
"first_name" : "John" ,
"formatted_name" : "John Smith" ,
"last_name" : "Smith"
} ,
"org" : {
"company" : "WhatsApp" ,
"department" : "Design" ,
"title" : "Manager"
} ,
"phones" : [
{
"phone" : "+1 (650) 555-1234" ,
"type" : "WORK" ,
"wa_id" : "16505551234"
}
] ,
"urls" : [
{
"url" : "https://www.facebook.com" ,
"type" : "WORK"
}
]
}
]
});
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/contacts' ,
headers : {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/contacts' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => '{
"to": "+90xxxxxxxxxx",
"contacts": [
{
"addresses": [
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "1 Hacker Way",
"type": "HOME",
"zip": "94025"
}
],
"birthday": "2012-08-18",
"emails": [
{
"email": "test@whatsapp.com",
"type": "WORK"
}
],
"name": {
"first_name": "John",
"formatted_name": "John Smith",
"last_name": "Smith"
},
"org": {
"company": "WhatsApp",
"department": "Design",
"title": "Manager"
},
"phones": [
{
"phone": "+1 (650) 555-1234",
"type": "WORK",
"wa_id": "16505551234"
}
],
"urls": [
{
"url": "https://www.facebook.com",
"type": "WORK"
}
]
}
]
}' ,
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json' ,
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
import json
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/contacts"
payload = json . dumps ({
"to" : "+90xxxxxxxxxx" ,
"contacts" : [
{
"addresses" : [
{
"city" : "Menlo Park" ,
"country" : "United States" ,
"country_code" : "us" ,
"state" : "CA" ,
"street" : "1 Hacker Way" ,
"type" : "HOME" ,
"zip" : "94025"
}
],
"birthday" : "2012-08-18" ,
"emails" : [
{
"email" : "test@whatsapp.com" ,
"type" : "WORK"
}
],
"name" : {
"first_name" : "John" ,
"formatted_name" : "John Smith" ,
"last_name" : "Smith"
},
"org" : {
"company" : "WhatsApp" ,
"department" : "Design" ,
"title" : "Manager"
},
"phones" : [
{
"phone" : "+1 (650) 555-1234" ,
"type" : "WORK" ,
"wa_id" : "16505551234"
}
],
"urls" : [
{
"url" : "https://www.facebook.com" ,
"type" : "WORK"
}
]
}
]
})
headers = {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload)
print (response.text)
Send WhatsApp Media Message
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias
Send media messages to an active WhatsApp number.
Path Parameters
The ID of your integration
Request Body
WhatsApp number to be sent. It should start with (+) and a country code.
Attachment for the message (Only allowed in form-data).
Max Count: 5, Max Size: 20MB
200
Copy {
"medias" : {
"images" : [
{
"url" : "https://my-cdn.desk360.com/integrations/integrationId/attachments/bTARCYuscrcWU20t0dA8aesXufZKVuS0INd8rR5L.png" ,
"name" : "desk360.png" ,
"type" : "image" ,
"aws" : true ,
"content_type" : "image/png" ,
"message_id" : "gBEGkFBXUQRnAgkEg3us4YW8UJE" ,
"media_id" : "cae26b43-1463-44f5-9a81-f4119afbf6d9"
}
]
}
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--form 'to="+90xxxxxxxxxx"' \
--form 'attachments[]=@"/path/to/file"'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages/medias" , Method . Post );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
request . AlwaysMultipartFormData = true ;
request .AddParameter( "to" , "+90xxxxxxxxxx" );
request .AddFile( "attachments[]" , "/path/to/file" );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "text/plain" );
RequestBody body = new MultipartBody . Builder () . setType ( MultipartBody . FORM )
. addFormDataPart ( "to" , "+90xxxxxxxxxx" )
. addFormDataPart ( "attachments[]" , "file" ,
RequestBody . create ( MediaType . parse ( "application/octet-stream" ) ,
new File( "/path/to/file" ) ))
. build ();
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias" )
. method ( "POST" , body)
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
const FormData = require ( 'form-data' );
const fs = require ( 'fs' );
let data = new FormData ();
data .append ( 'to' , '+90xxxxxxxxxx' );
data .append ( 'attachments[]' , fs .createReadStream ( '/path/to/file' ));
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias' ,
headers : {
'Authorization' : 'Bearer YOUR_API_TOKEN' ,
... data .getHeaders ()
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => array( 'to' => '+90xxxxxxxxxx' , 'attachments[]' => new CURLFILE ( '/path/to/file' )) ,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias"
payload = { 'to' : '+90xxxxxxxxxx' }
files = [
( 'attachments[]' , ( 'file' , open ( '/path/to/file' , 'rb' ), 'application/octet-stream' ))
]
headers = {
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload, files = files)
print (response.text)
Get WhatsApp Media
GET
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId
Get whatsapp media by media id.
Path Parameters
The ID of your integration
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request GET 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId' \
--header 'Authorization: Bearer YOUR_API_TOKEN'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages/medias/:mediaId" , Method . Get );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "text/plain" );
MediaType JSON = MediaType . parse ( "application/json; charset=utf-8" );
RequestBody body = RequestBody . create (JSON , "{}" );
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId" )
. method ( "GET" , body)
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
const FormData = require ( 'form-data' );
let data = new FormData ();
let config = {
method : 'get' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId' ,
headers : {
'Authorization' : 'Bearer YOUR_API_TOKEN' ,
... data .getHeaders ()
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'GET' ,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/medias/:mediaId"
payload = {}
files = {}
headers = {
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "GET" , url, headers = headers, data = payload, files = files)
print (response.text)
Send WhatsApp Interactive Message
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive
Send interactive message to an active WhatsApp number.
Path Parameters
The ID of your integration
Request Body
WhatsApp number to be sent. It should start with (+) and a country code.
Message body. It must be max 1024 chars.
Required parameters for the interactive message. It must be max 10 button object item.
Unique identifier for your button. This ID is returned in the webhook when the button is clicked by the user. Maximum length: 200 chars.
Button title. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Maximum length: 20 chars.
An object with the header of the message.
Required if header is set. Supported values: text, image, video or document.
Required if header's type is text. It must be max 60 chars.
Required if header's type is document.
Header's document filename.
Required if header's type is video.
Required if header's type is image.
An object with the footer of the message.
Required if footer object. It must be max 60 chars.
200
Copy {
"message_id" : "gBEGkFBXUQRnAglHuQTBEMHpUdo"
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data '{
"to": "+90xxxxxxxxxx",
"header": {
"type": "image",
"image": {
"link": "https://fastly.picsum.photos/id/879/200/300.jpg?hmac=07llkorYxtpw0EwxaeqFKPC5woveWVLykQVnIOyiwd8"
}
},
"body": "<p>Hello</p>",
"footer": {
"text": "<b>Bye</b>"
},
"buttons": [
{
"id": "ID 1.1",
"title": "Button 1"
},
{
"id": "ID 1.2",
"title": "Button 2"
},
{
"id": "ID 1.3",
"title": "Button 3"
}
]
}'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages/interactive" , Method . Post );
request .AddHeader( "Content-Type" , "application/json" );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
var body = @"{" + "\n" +
@" ""to"": ""+90xxxxxxxxxx""," + "\n" +
@" ""header"": {" + "\n" +
@" ""type"": ""image""," + "\n" +
@" ""image"": {" + "\n" +
@" ""link"": ""https://fastly.picsum.photos/id/879/200/300.jpg?hmac=07llkorYxtpw0EwxaeqFKPC5woveWVLykQVnIOyiwd8""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""body"": ""<p>Hello</p>""," + "\n" +
@" ""footer"": {" + "\n" +
@" ""text"": ""<b>Bye</b>""" + "\n" +
@" }," + "\n" +
@" ""buttons"": [" + "\n" +
@" {" + "\n" +
@" ""id"": ""ID 1.1""," + "\n" +
@" ""title"": ""Button 1""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""ID 1.2""," + "\n" +
@" ""title"": ""Button 2""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""ID 1.3""," + "\n" +
@" ""title"": ""Button 3""" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@"}" ;
request .AddStringBody(body , DataFormat . Json );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "application/json" );
RequestBody body = RequestBody.create(mediaType, "{\n \"to\": \"+90xxxxxxxxxx\",\n \"header\": {\n \"type\": \"image\",\n \"image\": {\n \"link\": \"https://fastly.picsum.photos/id/879/200/300.jpg?hmac=07llkorYxtpw0EwxaeqFKPC5woveWVLykQVnIOyiwd8\"\n }\n },\n \"body\": \"<p>Hello</p>\",\n \"footer\": {\n \"text\": \"<b>Bye</b>\"\n },\n \"buttons\": [\n {\n \"id\": \"ID 1.1\",\n \"title\": \"Button 1\"\n },\n {\n \"id\": \"ID 1.2\",\n \"title\": \"Button 2\"\n },\n {\n \"id\": \"ID 1.3\",\n \"title\": \"Button 3\"\n }\n ]\n}");
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive" )
. method ( "POST" , body)
. addHeader ( "Content-Type" , "application/json" )
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
let data = JSON .stringify ({
"to" : "+90xxxxxxxxxx" ,
"header" : {
"type" : "image" ,
"image" : {
"link" : "https://fastly.picsum.photos/id/879/200/300.jpg?hmac=07llkorYxtpw0EwxaeqFKPC5woveWVLykQVnIOyiwd8"
}
} ,
"body" : "<p>Hello</p>" ,
"footer" : {
"text" : "<b>Bye</b>"
} ,
"buttons" : [
{
"id" : "ID 1.1" ,
"title" : "Button 1"
} ,
{
"id" : "ID 1.2" ,
"title" : "Button 2"
} ,
{
"id" : "ID 1.3" ,
"title" : "Button 3"
}
]
});
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive' ,
headers : {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => '{
"to": "+90xxxxxxxxxx",
"header": {
"type": "image",
"image": {
"link": "https://fastly.picsum.photos/id/879/200/300.jpg?hmac=07llkorYxtpw0EwxaeqFKPC5woveWVLykQVnIOyiwd8"
}
},
"body": "<p>Hello</p>",
"footer": {
"text": "<b>Bye</b>"
},
"buttons": [
{
"id": "ID 1.1",
"title": "Button 1"
},
{
"id": "ID 1.2",
"title": "Button 2"
},
{
"id": "ID 1.3",
"title": "Button 3"
}
]
}' ,
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json' ,
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
import json
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive"
payload = json . dumps ({
"to" : "+90xxxxxxxxxx" ,
"header" : {
"type" : "image" ,
"image" : {
"link" : "https://fastly.picsum.photos/id/879/200/300.jpg?hmac=07llkorYxtpw0EwxaeqFKPC5woveWVLykQVnIOyiwd8"
}
},
"body" : "<p>Hello</p>" ,
"footer" : {
"text" : "<b>Bye</b>"
},
"buttons" : [
{
"id" : "ID 1.1" ,
"title" : "Button 1"
},
{
"id" : "ID 1.2" ,
"title" : "Button 2"
},
{
"id" : "ID 1.3" ,
"title" : "Button 3"
}
]
})
headers = {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload)
print (response.text)
Send WhatsApp Location Request Interactive Message
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request
Send location request interactive message to an active WhatsApp number.
Path Parameters
The ID of your integration
Request Body
WhatsApp number to be sent. It should start with (+) and a country code.
Message body. It must be max 1024 chars.
200
Copy {
"message_id" : "gBEGkFBXUQRnAgn6gWf5CzaF6Ko"
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--data '{
"to": "+90xxxxxxxxxx",
"body": "<i>Send Location</i>"
}'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages/interactive/location-request" , Method . Post );
request .AddHeader( "Content-Type" , "application/json" );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
var body = @"{" + "\n" +
@" ""to"": ""+90xxxxxxxxxx""," + "\n" +
@" ""body"": ""<i>Send Location</i>""" + "\n" +
@"}" ;
request .AddStringBody(body , DataFormat . Json );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "application/json" );
RequestBody body = RequestBody . create (mediaType , "{\n \"to\": \"+90xxxxxxxxxx\",\n \"body\": \"<i>Send Location</i>\"\n}" );
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request" )
. method ( "POST" , body)
. addHeader ( "Content-Type" , "application/json" )
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
let data = JSON .stringify ({
"to" : "+90xxxxxxxxxx" ,
"body" : "<i>Send Location</i>"
});
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request' ,
headers : {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => '{
"to": "+90xxxxxxxxxx",
"body": "<i>Send Location</i>"
}' ,
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json' ,
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
import json
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/interactive/location-request"
payload = json . dumps ({
"to" : "+90xxxxxxxxxx" ,
"body" : "<i>Send Location</i>"
})
headers = {
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload)
print (response.text)
Read WhatsApp Message
POST
https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/reads
Mark messages from webhook as read.
Path Parameters
The ID of your integration
Request Body
Message ids to mark as read
WhatsApp number to be read. It should start with (+) and a country code.
200
Copy {
"message_ids" : [
"gBEGkFBXUQRnAgn6gWf5CzaF6Ko" ,
"gBEGkFBXUQRnAglHuQTBEMHpUdo"
]
}
Code Samples
cURL C# Java JavaScript PHP Python
Copy curl --location --request POST 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/reads' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--form 'to="+90xxxxxxxxxx"' \
--form 'message_ids[]="xxxxxxxxxxxxxxxx"'
Copy var options = new RestClientOptions ( "https://public-api.desk360.com" )
{
MaxTimeout = - 1 ,
};
var client = new RestClient (options);
var request = new RestRequest ( "/v1/integrations/:integrationId/conversations/messages/reads" , Method . Post );
request .AddHeader( "Authorization" , "Bearer YOUR_API_TOKEN" );
request . AlwaysMultipartFormData = true ;
request .AddParameter( "to" , "+90xxxxxxxxxx" );
request .AddParameter( "message_ids[]" , "xxxxxxxxxxxxxxxx" );
RestResponse response = await client .ExecuteAsync(request);
Console .WriteLine( response . Content );
Copy OkHttpClient client = new OkHttpClient() . newBuilder ()
. build ();
MediaType mediaType = MediaType . parse ( "text/plain" );
RequestBody body = new MultipartBody . Builder () . setType ( MultipartBody . FORM )
. addFormDataPart ( "to" , "+90xxxxxxxxxx" )
. addFormDataPart ( "message_ids[]" , "xxxxxxxxxxxxxxxx" )
. build ();
Request request = new Request . Builder ()
. url ( "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/reads" )
. method ( "POST" , body)
. addHeader ( "Authorization" , "Bearer YOUR_API_TOKEN" )
. build ();
Response response = client . newCall (request) . execute ();
Copy const axios = require ( 'axios' );
const FormData = require ( 'form-data' );
let data = new FormData ();
data .append ( 'to' , '+90xxxxxxxxxx' );
data .append ( 'message_ids[]' , 'xxxxxxxxxxxxxxxx' );
let config = {
method : 'post' ,
maxBodyLength : Infinity ,
url : 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/reads' ,
headers : {
'Authorization' : 'Bearer YOUR_API_TOKEN' ,
... data .getHeaders ()
} ,
data : data
};
axios .request (config)
.then ((response) => {
console .log ( JSON .stringify ( response .data));
})
.catch ((error) => {
console .log (error);
});
Copy <? php
$curl = curl_init () ;
curl_setopt_array ( $curl , array(
CURLOPT_URL => 'https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/reads' ,
CURLOPT_RETURNTRANSFER => true ,
CURLOPT_ENCODING => '' ,
CURLOPT_MAXREDIRS => 10 ,
CURLOPT_TIMEOUT => 0 ,
CURLOPT_FOLLOWLOCATION => true ,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1 ,
CURLOPT_CUSTOMREQUEST => 'POST' ,
CURLOPT_POSTFIELDS => array( 'message_ids[]' => 'xxxxxxxxxxxxxxxx' , 'to' => '+90xxxxxxxxxx' ) ,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer YOUR_API_TOKEN'
) ,
) ) ;
$response = curl_exec ( $curl ) ;
curl_close ( $curl ) ;
echo $response;
Copy import requests
url = "https://public-api.desk360.com/v1/integrations/:integrationId/conversations/messages/reads"
payload = { 'message_ids[]' : 'xxxxxxxxxxxxxxxx' , 'to' : '+90xxxxxxxxxx' }
files = [
]
headers = {
'Authorization' : 'Bearer YOUR_API_TOKEN'
}
response = requests . request ( "POST" , url, headers = headers, data = payload, files = files)
print (response.text)
WhatsApp Webhooks
Subscribe to Webhooks to be notified about messages and message status updates your business receives.
Received Messages Examples
Text Messages
Copy {
"messages" : {
"id" : "ABEGkFMIcyRoAgo-sGaD-H6MgPEt" ,
"text" : "Hello" ,
"from" : "90xxxxxxxxxx" ,
"timestamp" : "1630913975" ,
"name" : "John Doe" ,
"type" : "text"
}
}
Location Messages
Copy {
"messages" : {
"id" : "ABEGkFBXUQRnAgo6cHkZc1yy0dAx" ,
"text" : "Main Street Beach - Main Street Beach, Santa Cruz, CA, latitude: 38.9806263495, longitude: -131.9428612257" ,
"from" : "90xxxxxxxxxx" ,
"timestamp" : "1700052659" ,
"name" : "John Doe" ,
"location" : {
"address" : "Main Street Beach, Santa Cruz, CA" ,
"latitude" : 38.9806263495 ,
"longitude" : -131.9428612257 ,
"name" : "Main Street Beach"
} ,
"type" : "location"
}
}
Contact Messages
Copy {
"messages" : {
"id" : "ABEGkFBXUQRnAgo6PXn8aI1fmlOm" ,
"from" : "90xxxxxxxxxx" ,
"timestamp" : "1700052797" ,
"name" : "John Doe" ,
"type" : "contacts" ,
"contacts" : [
{
"addresses" : [
{
"city" : "Menlo Park" ,
"country" : "United States" ,
"country_code" : "us" ,
"state" : "CA" ,
"street" : "1 Hacker Way" ,
"type" : "WORK" ,
"zip" : "94025"
}
] ,
"birthday" : "2012-08-18" ,
"emails" : [
{
"email" : "kfish@fb.com" ,
"type" : "WORK"
}
] ,
"ims" : [
{
"service" : "AIM" ,
"user_id" : "kfish"
}
] ,
"name" : {
"first_name" : "Kerry" ,
"formatted_name" : "Kerry Fisher" ,
"last_name" : "Fisher"
} ,
"org" : {
"company" : "Meta" ,
"department" : "WhatsApp"
} ,
"phones" : [
{
"phone" : "+1 (650) 555-1234" ,
"type" : "WORK" ,
"wa_id" : "16505551234"
}
] ,
"urls" : [
{
"url" : "https://www.facebook.com" ,
"type" : "WORK"
}
]
}
]
}
}
Media Messages
Copy {
"messages" : {
"id" : "ABEGkFBXUQRnAgo6xTEQCONO2nW9" ,
"from" : "90xxxxxxxxxx" ,
"timestamp" : "1689756449" ,
"name" : "John Doe" ,
"image" : {
"message" : null ,
"media_id" : "83518734-56a9-4b51-8372-93f1432cfa9b" ,
"mime_type" : "image/jpeg" ,
"sha" : "7e18d97d50eea65a50d9fa93db26e1c689da7c7de64d829b22aad38c4f541510"
} ,
"attachments" : {
"images" : [
{
"url" : "https://path/to/file/9oCtWHWxkv4E0PQhtHA4uW4NRinIROKCO8NEae5p.jpeg" ,
"name" : "9oCtWHWxkv4E0PQhtHA4uW4NRinIROKCO8NEae5p.jpeg" ,
"type" : "image" ,
"aws" : true
}
]
} ,
"type" : "image"
}
}
Status Updates
Copy {
"statuses" : {
"id" : "gBEGkFBXUQRnAglM82HET_hbwJs" ,
"from" : "90xxxxxxxxxx" ,
"status" : "delivered|read"
}
}
Homepage Pricing