API Collection

Here is the collection of all the Tellephant API requests.
Get Postman Collection

Using these boilerplate requests, you can test and explore the APIs in any environment.

Messaging Service APIs

HSM / Template Messages

HSM / Template Messages Example request:

curl -X POST \
    "https://api.tellephant.com/v1/send-message" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"ABCDEFGHIJKLMNOPQRSTUVWXYZ","to":919999999999,"channels":["whatsapp"],"whatsapp":{"contentType":"template","template":{"templateId":"dummy_template_name","language":"en","components":[]}}}'

const url = new URL(
    "https://api.tellephant.com/v1/send-message"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.tellephant.com/v1/send-message',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
            'to' => 919999999999,
            'channels' => [
                'whatsapp',
            ],
            'whatsapp' => [
                'contentType' => 'template',
                'template' => [
                    'templateId' => 'dummy_template_name',
                    'language' => 'en',
                    'components' => [],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.tellephant.com/v1/send-message'
payload = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example Component HSM / Template (TEXT):

   "components" : [
                 {
                     "type" : "body",
                     "parameters" : [
                         {
                             "type" : "text",
                             "text" : "Dummy Text 1"
                         },
                         {
                             "type" : "text",
                             "text" : "Dummy Text 2"
                         }

                    ]
                 }
             ]

1

Example Component HSM / Template (IMAGE):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "image",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.jpeg"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                }
            ]

Example Component HSM / Template (DOCUMENT):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "document",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.pdf",
                                "filename": "Sample PDF"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                }
            ]

Example Component HSM / Template (VIDEO):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "video",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.mp4",
                                "caption": "Sample Video"
                            }
                        }
                    ]
                }
            ]

Example Component HSM / Template (Location):

"components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "location",
                            "location": {
                                "latitude": 51.5005765,
                                "longitude": 7.4954884
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Your text here"
                        }
                    ]
                }
            ]

Example response (200):

{
    "success": true,
    "messageId": "CAGHDVFHVFUDUYRFGUFJYR"
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

Example response (401):

{
    "status": false,
    "error": "Please subscribe to addon first"
}

Example response (403):

{
    "status": false,
    "error": "Balance Low! Please recharge!"
}

Send messages via this path.

POST v1/send-message

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
to	integer	required	Number to send the message
channels	array	required	Channel(s) to be used.
whatsapp.contentType	String	required	Content type used
whatsapp.template	array	required	Template Details
whatsapp.template.templateId	String	required	Template identifier string
whatsapp.template.language	String	required	Language in the template
whatsapp.template.components	array	required	Template Data

HSM / Template (Text)

Parameter	In	Type	Status	Description
parameters	body	array	required	Parameters to be used in Component
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (Image)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Image header
url	media	String	required	The url of the location where the image is stored
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (Document)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Document header
url	media	String	required	The url of the location where the document is stored
filename	media	String	required	Document Name
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (VIDEO)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Video header
url	media	String	required	The url of the location where the video is stored
caption	media	String	optional	Additional caption for the video.

HSM / Template (LOCATION)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Location component for Whatsapp HSM / Template
latitude	location	number(double)	required	Latitude component of location
longitude	location	number(double)	required	Longitude component of location
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM (Quick Reply Buttons)

HSM / Template Messages Example request:

curl -X POST \
    "https://api.tellephant.com/v1/send-message" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"ABCDEFGHIJKLMNOPQRSTUVWXYZ","to":919999999999,"channels":["whatsapp"],"whatsapp":{"contentType":"template","template":{"templateId":"dummy_template_name","language":"en","components":[]}}}'

const url = new URL(
    "https://api.tellephant.com/v1/send-message"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.tellephant.com/v1/send-message',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
            'to' => 919999999999,
            'channels' => [
                'whatsapp',
            ],
            'whatsapp' => [
                'contentType' => 'template',
                'template' => [
                    'templateId' => 'dummy_template_name',
                    'language' => 'en',
                    'components' => [],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.tellephant.com/v1/send-message'
payload = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example Component HSM / Template (TEXT with Quick Reply buttons):

   "components" : [
                 {
                     "type" : "body",
                     "parameters" : [
                         {
                             "type" : "text",
                             "text" : "Dummy Text 1"
                         },
                         {
                             "type" : "text",
                             "text" : "Dummy Text 2"
                         }

                    ]
                 }
             ]

1

Example Component HSM / Template (IMAGE with Quick Reply buttons):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "image",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.jpeg"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                }
            ]

Example Component HSM / Template (DOCUMENT with Quick Reply buttons):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "document",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.pdf",
                                "filename": "Sample PDF"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                }
            ]

Example Component HSM / Template (VIDEO with Quick Reply buttons):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "video",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.mp4",
                                "caption": "Sample Video"
                            }
                        }
                    ]
                }
            ]

Example Component HSM / Template (Location with Quick Reply buttons):

"components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "location",
                            "location": {
                                "latitude": 51.5005765,
                                "longitude": 7.4954884
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Your text here"
                        }
                    ]
                }
            ]

Example response (200):

{
    "success": true,
    "messageId": "CAGHDVFHVFUDUYRFGUFJYR"
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

Example response (401):

{
    "status": false,
    "error": "Please subscribe to addon first"
}

Example response (403):

{
    "status": false,
    "error": "Balance Low! Please recharge!"
}

Send messages via this path.

POST v1/send-message

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
to	integer	required	Number to send the message
channels	array	required	Channel(s) to be used.
whatsapp.contentType	String	required	Content type used
whatsapp.template	array	required	Template Details
whatsapp.template.templateId	String	required	Template identifier string
whatsapp.template.language	String	required	Language in the template
whatsapp.template.components	array	required	Template Data

Note-
Quick Replies are typically used if you wish to give your users the choice between 1–3 possible answers. The user then simply needs to tap one of the quick replies to answer to your message.
No extra component is required in the request to send an HSM / Template with Quick Reply buttons.

HSM / Template (Text with Quick Reply buttons)

Parameter	In	Type	Status	Description
parameters	body	array	required	Parameters to be used in Component
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (Image with Quick Reply buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Image header
url	media	String	required	The url of the location where the image is stored
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (Document with Quick Reply buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Document header
url	media	String	required	The url of the location where the document is stored
filename	media	String	required	Document Name
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (VIDEO with Quick Reply buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Video header
url	media	String	required	The url of the location where the video is stored
caption	media	String	optional	Additional caption for the video.

HSM / Template (LOCATION with Quick Reply buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Location component for Whatsapp HSM / Template
latitude	location	number(double)	required	Latitude component of location
longitude	location	number(double)	required	Longitude component of location
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM (CTA Buttons)

HSM / Template Messages Example request:

curl -X POST \
    "https://api.tellephant.com/v1/send-message" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"ABCDEFGHIJKLMNOPQRSTUVWXYZ","to":919999999999,"channels":["whatsapp"],"whatsapp":{"contentType":"template","template":{"templateId":"dummy_template_name","language":"en","components":[]}}}'

const url = new URL(
    "https://api.tellephant.com/v1/send-message"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.tellephant.com/v1/send-message',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
            'to' => 919999999999,
            'channels' => [
                'whatsapp',
            ],
            'whatsapp' => [
                'contentType' => 'template',
                'template' => [
                    'templateId' => 'dummy_template_name',
                    'language' => 'en',
                    'components' => [],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.tellephant.com/v1/send-message'
payload = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example Component HSM / Template (TEXT with CTA buttons):

   "components" : [
                 {
                     "type" : "body",
                     "parameters" : [
                         {
                             "type" : "text",
                             "text" : "Dummy Text 1"
                         },
                         {
                             "type" : "text",
                             "text" : "Dummy Text 2"
                         }

                    ]
                 }
             ]

1

Example Component HSM / Template (IMAGE with CTA buttons):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "image",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.jpeg"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                }
            ]

Example Component HSM / Template (DOCUMENT with CTA buttons):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "document",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.pdf",
                                "filename": "Sample PDF"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                }
            ]

Example Component HSM / Template (VIDEO with CTA buttons):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "video",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.mp4",
                                "caption": "Sample Video"
                            }
                        }
                    ]
                }
            ]

Example Component HSM / Template (Location with CTA buttons):

"components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "location",
                            "location": {
                                "latitude": 51.5005765,
                                "longitude": 7.4954884
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Your text here"
                        }
                    ]
                }
            ]

Example response (200):

{
    "success": true,
    "messageId": "CAGHDVFHVFUDUYRFGUFJYR"
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

Example response (401):

{
    "status": false,
    "error": "Please subscribe to addon first"
}

Example response (403):

{
    "status": false,
    "error": "Balance Low! Please recharge!"
}

Send messages via this path.

POST v1/send-message

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
to	integer	required	Number to send the message
channels	array	required	Channel(s) to be used.
whatsapp.contentType	String	required	Content type used
whatsapp.template	array	required	Template Details
whatsapp.template.templateId	String	required	Template identifier string
whatsapp.template.language	String	required	Language in the template
whatsapp.template.components	array	required	Template Data

Note-
A Call to Action can be either an URL or phone number. For example, a direct link to your website/app, or the phone number to call your business. URLs can be either static or have a dynamic parameter at the end of the URL.
No extra component is required in the request to send an HSM/Template with static CTA buttons. Example request for dynamic can be found in the next section.

HSM / Template (Text with CTA buttons)

Parameter	In	Type	Status	Description
parameters	body	array	required	Parameters to be used in Component
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (Image with CTA buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Image header
url	media	String	required	The url of the location where the image is stored
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (Document with CTA buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Document header
url	media	String	required	The url of the location where the document is stored
filename	media	String	required	Document Name
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM / Template (VIDEO with CTA buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Media component for Whatsapp HSM / Template
type	media	String	required	Video header
url	media	String	required	The url of the location where the video is stored
caption	media	String	optional	Additional caption for the video.

HSM / Template (LOCATION with CTA buttons)

Parameter	In	Type	Status	Description
parameters	header	array	required	Parameters to be used in Component
type	header	String	required	Location component for Whatsapp HSM / Template
latitude	location	number(double)	required	Latitude component of location
longitude	location	number(double)	required	Longitude component of location
type	body	String	required	Text component for Whatsapp HSM / Template
text	body	String	required	The text to be sent

HSM (Dynamic CTA redirect Button)

HSM / Template Messages Example request:

curl -X POST \
    "https://api.tellephant.com/v1/send-message" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"ABCDEFGHIJKLMNOPQRSTUVWXYZ","to":919999999999,"channels":["whatsapp"],"whatsapp":{"contentType":"template","template":{"templateId":"dummy_template_name","language":"en","components":[]}}}'

const url = new URL(
    "https://api.tellephant.com/v1/send-message"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.tellephant.com/v1/send-message',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
            'to' => 919999999999,
            'channels' => [
                'whatsapp',
            ],
            'whatsapp' => [
                'contentType' => 'template',
                'template' => [
                    'templateId' => 'dummy_template_name',
                    'language' => 'en',
                    'components' => [],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.tellephant.com/v1/send-message'
payload = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {
        "contentType": "template",
        "template": {
            "templateId": "dummy_template_name",
            "language": "en",
            "components": []
        }
    }
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example Component HSM / Template (TEXT with Dynamic CTA redirect button):

   "components" : [
                 {
                     "type" : "body",
                     "parameters" : [
                         {
                             "type" : "text",
                             "text" : "Dummy Text 1"
                         },
                         {
                             "type" : "text",
                             "text" : "Dummy Text 2"
                         }
                    ]
                 },
                 {
                    "type": "button",
                    "subType": "url",
                    "index": 0,
                    "parameters": [
                        {
                            "type": "text",
                            "text": "url_variable"
                        }
                    ]
                }
             ]

1

Example Component HSM / Template (IMAGE with Dynamic CTA redirect button):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "image",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.jpeg"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                },
                {
                    "type": "button",
                    "subType": "url",
                    "index": 0,
                    "parameters": [
                        {
                            "type": "text",
                            "text": "url_variable"
                        }
                    ]
                }
            ]

Example Component HSM / Template (DOCUMENT with Dynamic CTA redirect button):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "document",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.pdf",
                                "filename": "Sample PDF"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                },
                {
                    "type": "button",
                    "subType": "url",
                    "index": 0,
                    "parameters": [
                        {
                            "type": "text",
                            "text": "url_variable"
                        }
                    ]
                }
            ]

Example Component HSM / Template (VIDEO with Dynamic CTA redirect button):

   "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "media",
                            "media": {
                                "type": "video",
                                "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.mp4",
                                "caption": "Sample Video"
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Dummy Text 1"
                        },
                        {
                            "type": "text",
                            "text": "Dummy Text 2"
                        }
                    ]
                },
                {
                    "type": "button",
                    "subType": "url",
                    "index": 0,
                    "parameters": [
                        {
                            "type": "text",
                            "text": "url_variable"
                        }
                    ]
                }
            ]

Example Component HSM / Template (Location with Dynamic CTA redirect button):

"components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "location",
                            "location": {
                                "latitude": 51.5005765,
                                "longitude": 7.4954884
                            }
                        }
                    ]
                },
                {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Your text here"
                        }
                    ]
                },
                {
                    "type": "button",
                    "subType": "url",
                    "index": 0,
                    "parameters": [
                        {
                            "type": "text",
                            "text": "url_variable"
                        }
                    ]
                }
            ]

Example response (200):

{
    "success": true,
    "messageId": "CAGHDVFHVFUDUYRFGUFJYR"
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

Example response (401):

{
    "status": false,
    "error": "Please subscribe to addon first"
}

Example response (403):

{
    "status": false,
    "error": "Balance Low! Please recharge!"
}

Send messages via this path.

POST v1/send-message

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
to	integer	required	Number to send the message
channels	array	required	Channel(s) to be used.
whatsapp.contentType	String	required	Content type used
whatsapp.template	array	required	Template Details
whatsapp.template.templateId	String	required	Template identifier string
whatsapp.template.language	String	required	Language in the template
whatsapp.template.components	array	required	Template Data

Note-
URLs can be either static or have a dynamic parameter at the end of the URL.
Dynamic URLs can have one variable at the end of the URL, e.g. https://www.tellephant.com/my-url-{{1}}

HSM / Template (Text with Dynamic CTA redirect button)

Parameter	In	Type	Status	Description
parameter.type	body	String	required	Text component for Whatsapp HSM / Template
parameter.text	body	String	required	The text to be sent
type	button	String	required	CTA button component for Whatsapp HSM / Template
subType	button	String	required	Type of CTA button
index	button	numeric	required	0 if URL button precedes PHONE button, and 1 otherwise
parameter.type	button	String	required	Data type of URL variable
parameter.text	button	String	required	Variable put in the dynamic URL

HSM / Template (Image with Dynamic CTA redirect button)

Parameter	In	Type	Status	Description
parameters.type	header	String	required	Media component for Whatsapp HSM / Template
media.type	header	String	required	Image header
media.url	header	String	required	The url of the location where the image is stored
parameter.type	body	String	required	Text component for Whatsapp HSM / Template
parameter.text	body	String	required	The text to be sent
type	button	String	required	CTA button component for Whatsapp HSM / Template
subType	button	String	required	Type of CTA button
index	button	numeric	required	0 if URL button precedes PHONE button, and 1 otherwise
parameter.type	button	String	required	Data type of URL variable
parameter.text	button	String	required	Variable put in the dynamic URL

HSM / Template (Document with Dynamic CTA redirect button)

Parameter	In	Type	Status	Description
paramters.type	header	String	required	Document header
media.url	header	String	required	The url of the location where the document is stored
media.filename	header	String	required	Document Name
media.type	body	String	required	Text component for Whatsapp HSM / Template
parameter.type	body	String	required	Text component for Whatsapp HSM / Template
parameter.text	body	String	required	The text to be sent
type	button	String	required	CTA button component for Whatsapp HSM / Template
subType	button	String	required	Type of CTA button
index	button	numeric	required	0 if URL button precedes PHONE button, and 1 otherwise
parameter.type	button	String	required	Data type of URL variable
parameter.text	button	String	required	Variable put in the dynamic URL

HSM / Template (VIDEO with Dynamic CTA redirect button)

Parameter	In	Type	Status	Description
paramters.type	header	String	required	Video header
media.type	header	String	required	Video header
media.url	header	String	required	The url of the location where the video is stored
media.caption	header	String	optional	Additional caption for the video.
parameter.type	body	String	required	Text component for Whatsapp HSM / Template
parameter.text	body	String	required	The text to be sent
type	button	String	required	CTA button component for Whatsapp HSM / Template
subType	button	String	required	Type of CTA button
index	button	numeric	required	0 if URL button precedes PHONE button, and 1 otherwise
parameter.type	button	String	required	Data type of URL variable
parameter.text	button	String	required	Variable put in the dynamic URL

HSM / Template (LOCATION with Dynamic CTA redirect button)

Parameter	In	Type	Status	Description
parameters.type	header	String	required	Location component for Whatsapp HSM / Template
location.latitude	header	number(double)	required	Latitude component of location
location.longitude	header	number(double)	required	Longitude component of location
parameter.type	body	String	required	Text component for Whatsapp HSM / Template
parameter.text	body	String	required	The text to be sent
type	button	String	required	CTA button component for Whatsapp HSM / Template
subType	button	String	required	Type of CTA button
index	button	numeric	required	0 if URL button precedes PHONE button, and 1 otherwise
parameter.type	button	String	required	Data type of URL variable
parameter.text	button	String	required	Variable put in the dynamic URL

Session Messages

Session Messages Example request:

curl -X POST \
    "https://api.tellephant.com/v1/send-message" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"ABCDEFGHIJKLMNOPQRSTUVWXYZ","to":919999999999,"channels":["whatsapp"],"whatsapp": {}}'

const url = new URL(
    "https://api.tellephant.com/v1/send-message"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {}
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.tellephant.com/v1/send-message',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
            'to' => 919999999999,
            'channels' => [
                'whatsapp',
            ],
            'whatsapp' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.tellephant.com/v1/send-message'
payload = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "channels": [
        "whatsapp"
    ],
    "whatsapp": {}
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example Component Session Message (TEXT):

"whatsapp" : {
        "contentType" : "text",
        "text" : "You message here"
    }

Example Component Session Message (IMAGE):

"whatsapp": {
        "contentType": "media",
        "media": {
            "type": "image",
            "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.jpeg"
            "caption": "Some text description"
        }
    }

Example Component Session Message (DOCUMENT):

"whatsapp": {
        "contentType": "media",
        "media": {
            "type": "document",
            "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.pdf",
            "filename" : "Sample PDF"
        }
    }

Example Component Session Message (STICKER):

"whatsapp": {
        "contentType": "media",
        "media": {
            "type": "sticker",
            "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.webp"
        }
    }

Example Component Session Message (VIDEO):

"whatsapp": {
        "contentType": "media",
        "media": {
            "type": "video",
            "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.mp4"
            "caption" : "Sample Video"
        }
    }

Example Component Session Message (AUDIO):

"whatsapp": {
        "contentType": "media",
        "media": {
            "type": "audio",
            "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/audio.mp3",
            "caption" : "Sample Audio"
        }
    }

Example Component Session Message (LOCATION):

"whatsapp": {
        "contentType": "location",
        "location": {
            "longitude": -73.9855,
            "latitude": 40.7580,
            "name" : "Times Square",
            "address" : "Manhattan, NY 10036, United States"
        }
    }

Example Component Session Message (CONTACT):

"whatsapp": {
        "contentType": "contacts",
        "contacts": [
            {
                "name": {
                    "formattedName": "XYZ ABC",
                    "firstName" : "XYZ"
                },
                "phones": [
                    {
                        "phone": "919999999999",
                        "type": "WORK"
                    }
                ]
            }
        ]
    }

Example Component Session Message (Interactive List):

"whatsapp": {
    "contentType": "interactive",
    "interactive": {
        "subType": "list",
        "components": {
            "header": {
                "type": "text",
                "text": "Choose your menu"
            },
            "body": {
                "type": "text",
                "text": "Hi Sarah, select your menu from the bottom list. Dressings and toppings are selected later on"
            },
            "footer": {
                "type": "text",
                "text": "Your tellephant food team"
            },
            "list": {
                "title": "Your menu",
                "sections": [
                    {
                        "title": "Vegan",
                        "rows": [
                            {
                                "payload": "green-dream-34987-234897234-234",
                                "title": "Green dream",
                                "description": "A bowl full of tasty leaves, soy beans and cucumber"
                            },
                            {
                                "payload": "rainbow-meets-rice-34987-234897234-234",
                                "title": "Rainbow meets rice",
                                "description": "A colorful selection of vegetables on a cozy bed of basmati rice"
                            }
                        ]
                    },
                    {
                        "title": "Vegetarian",
                        "rows": [
                            {
                                "payload": "italo-classic-34987-234897234-234",
                                "title": "Italo Classic",
                                "description": "Slices of tomates, with plucked pieces of mozzarella and basil leaves"
                            },
                            {
                                "payload": "egg-and-peas-34987-234897234-234",
                                "title": "Egg & Peas",
                                "description": "Tasty slices of eggs, on a whole wheat pasta salad with peas"
                            }
                        ]
                    }
                ]
            }
        }
    }
}

Example Component Session Message (Interactive Reply Buttons) - Text Header:

"whatsapp": {
    "contentType": "interactive",
    "interactive": {
        "subType": "buttons",
        "components": {
            "header": {
                "type": "text",
                "text": "Your request is queued"
            },
            "body": {
                "type": "text",
                "text": "How would you rate your bot experience"
            },
            "footer": {
                "type": "text",
                "text": "Your service bot"
            },
            "buttons": [
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-40980jvkdm9-234234234",
                        "title": "Poor"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-dsfgjlkhgdf-dg09u834334",
                        "title": "OK"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "9080923445nlkjß0_gß0923845083245dfg",
                        "title": "Good"
                    }
                }
            ]
        }
    }
}

Example Component Session Message (Interactive Reply Buttons) - Image Header:

"whatsapp": {
    "contentType": "interactive",
    "interactive": {
        "subType": "buttons",
        "components": {
            "header": {
                "type": "image",
                "image": {
                    "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.jpeg"
                }
            },
            "body": {
                "type": "text",
                "text": "How would you rate your bot experience"
            },
            "footer": {
                "type": "text",
                "text": "Your service bot"
            },
            "buttons": [
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-40980jvkdm9-234234234",
                        "title": "Poor"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-dsfgjlkhgdf-dg09u834334",
                        "title": "OK"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "9080923445nlkjß0_gß0923845083245dfg",
                        "title": "Good"
                    }
                }
            ]
        }
    }
}

Example Component Session Message (Interactive Reply Buttons) - Document Header:

"whatsapp": {
    "contentType": "interactive",
    "interactive": {
        "subType": "buttons",
        "components": {
            "header": {
                "type": "document",
                "document": {
                    "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.pdf",
                    "filename" : "Sample"
                }
            },
            "body": {
                "type": "text",
                "text": "How would you rate your bot experience"
            },
            "footer": {
                "type": "text",
                "text": "Your service bot"
            },
            "buttons": [
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-40980jvkdm9-234234234",
                        "title": "Poor"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-dsfgjlkhgdf-dg09u834334",
                        "title": "OK"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "9080923445nlkjß0_gß0923845083245dfg",
                        "title": "Good"
                    }
                }
            ]
        }
    }
}

Example Component Session Message (Interactive Reply Buttons) - Video Header:

"whatsapp": {
    "contentType": "interactive",
    "interactive": {
        "subType": "buttons",
        "components": {
            "header": {
                "type": "video",
                "video": {
                    "url": "https://tellephant.s3.ap-south-1.amazonaws.com/dummy-media/sample.mp4"
                }
            },
            "body": {
                "type": "text",
                "text": "How would you rate your bot experience"
            },
            "footer": {
                "type": "text",
                "text": "Your service bot"
            },
            "buttons": [
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-40980jvkdm9-234234234",
                        "title": "Poor"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "987298-dsfgjlkhgdf-dg09u834334",
                        "title": "OK"
                    }
                },
                {
                    "type": "reply",
                    "reply": {
                        "payload": "9080923445nlkjß0_gß0923845083245dfg",
                        "title": "Good"
                    }
                }
            ]
        }
    }
}

Send session messages via this path.

POST v1/send-message

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
to	integer	required	Number to send the otp
channels	array	required	Channel(s) to be used.
whatsapp	array	required	Session message type and other details.

Session Message (Text)

Parameter	Type	Status	Description
contentType	string	required	Text header for Whatsapp Session message
text	String	required	The text to be sent

Session Message (IMAGE)

Parameter	Type	Status	Description
contentType	string	required	Media header for Whatsapp Session message
type	String	required	Type of media used
url	String	required	Location where the image is stored
caption	String	required	Text description alongwith

Session Message (DOCUMENT)

Parameter	Type	Status	Description
contentType	string	required	Media header for Whatsapp Session message
type	String	required	Type of media used
url	String	required	Location where the document is stored
filename	String	Required	Title for the document

Session Message (STICKER)

Parameter	Type	Status	Description
contentType	string	required	Media header for Whatsapp Session message
type	String	required	Type of media used
url	String	required	Location where the sticker is stored

Session Message (VIDEO)

Parameter	Type	Status	Description
contentType	string	required	Media header for Whatsapp Session message
type	String	required	Type of media used
url	String	required	Location where the video is stored
caption	String	optional	Text description alongwith

Session Message (AUDIO)

Parameter	Type	Status	Description
contentType	string	required	Media header for Whatsapp Session message
type	String	required	Type of media used
url	String	required	Location where the audio file is stored
caption	String	optional	Text description alongwith

Session Message (LOCATION)

Parameter	Type	Status	Description
contentType	string	required	Location header for Whatsapp Session message
longitude	number(double)	required	Logitude component of location
latitude	number(double)	required	Latitude component of location
name	String	required	Name of the location
address	String	required	Address of the location

Session Message (CONTACT)

Parameter	Type	Status	Description
contentType	string	required	Contact header for Whatsapp Session message
formattedName	String	required	Full name of the entity
firstName	String	required	First name of the entity
phone	String	required	Contact phone number details
type	String	required	Type of contact

Session Message (Interactive List)

Parameter	Type	Status	Description
interactive.subType	string	required	Interactive list header for Whatsapp Session message
components.header	object	optional	Message header
header.text	string	required	Header text content
components.body	object	required	Message body text
body.text	string	required	Message body content
components.footer	object	optional	Message footer
footer.text	string	required	Message footer content
list.title	string	optional	Title of the list (Max length: 24 characters)
list.section	array	required	Array of section objects (minimum of 1 and maximum of 10)
section.title	string	required (if multiple sections)	Title of the section (Max length: 24 characters)
section.rows	array	required	Contains a list of rows.
rows.title	string	required	row title (Max length: 24 characters)
rows.payload	string	required	payload (Max length: 200 characters)
rows.description	string	optional	description (Max length: 72 characters)

Note-
Maximum 10 number of rows allowed. Rows can be wrapped up in sections. A section shall have at least one row.
Payload must be unique for every row.

Session Message (Interactive Reply Buttons) - Text Header

Parameter	Type	Status	Description
interactive.subType	string	required	Interactive buttons header for Whatsapp Session message
components.header	object	optional	Message header
header.type	string	required	Type of header
header.text	string	required	Header text content
components.body	object	required	Message body
body.text	string	required	Message body content
components.footer	object	optional	Message footer
footer.text	string	required	Message footer content
buttons.type	string	required	Type of buttons
reply.title	string	required	Button title (Max length: 20 characters)
reply.payload	string	required	Payload (Max length: 256 characters)

Note-
Maximum 3 and minimum 1 button shall be included in this request.

Session Message (Interactive Reply Buttons) - Image Header

Parameter	Type	Status	Description
interactive.subType	string	required	Interactive buttons header for Whatsapp Session message
components.header	object	optional	Message header
header.type	string	required	Type of header
header.image.url	string	required	The url of the location where the image is stored
components.body	object	required	Message body
body.text	string	required	Message body content
components.footer	object	optional	Message footer
footer.text	string	required	Message footer content
buttons.type	string	required	Type of buttons
reply.title	string	required	Button title (Max length: 20 characters)
reply.payload	string	required	Payload (Max length: 256 characters)

Note-
Maximum 3 and minimum 1 button shall be included in this request.

Session Message (Interactive Reply Buttons) - Document Header

Parameter	Type	Status	Description
interactive.subType	string	required	Interactive buttons header for Whatsapp Session message
components.header	object	optional	Message header
header.type	string	required	Type of header
header.document.url	string	required	The url of the location where the pdf is stored
header.document.filename	string	required	PDF file name
components.body	object	required	Message body
body.text	string	required	Message body content
components.footer	object	optional	Message footer
footer.text	string	required	Message footer content
buttons.type	string	required	Type of buttons
reply.title	string	required	Button title (Max length: 20 characters)
reply.payload	string	required	Payload (Max length: 256 characters)

Note-
Maximum 3 and minimum 1 button shall be included in this request.

Session Message (Interactive Reply Buttons) - Video Header

Parameter	Type	Status	Description
interactive.subType	string	required	Interactive buttons header for Whatsapp Session message
components.header	object	optional	Message header
header.type	string	required	Type of header
header.video.url	string	required	The url of the location where the video is stored
components.body	object	required	Message body
body.text	string	required	Message body content
components.footer	object	optional	Message footer
footer.text	string	required	Message footer content
buttons.type	string	required	Type of buttons
reply.title	string	required	Button title (Max length: 20 characters)
reply.payload	string	required	Payload (Max length: 256 characters)

Note-
Maximum 3 and minimum 1 button shall be included in this request.

Message History

Message History Example request:

curl --location --request POST 'https://api.tellephant.com/v1/message-history' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apikey" : "< apikey >",
    "messageId" : "< message id >"
}'

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({"apikey":"< apikey >","messageId":"< message id >"});30

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.tellephant.com/v1/message-history", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('https://api.tellephant.com/v1/message-history');
$request->setRequestMethod('POST');
$body = new http\Message\Body;
$body->append('{
    "apikey" : "< apikey >",
    "messageId" : "< message id >"
}');
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
  'Content-Type' => 'application/json'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

import requests

url = "https://api.tellephant.com/v1/message-history"

payload="{\"apikey\" : \"< apikey >\",    \"messageId\" : \"< message id >\"}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Example response (200):

[
    {
        "message_state": "message-accepted",
        "happened_at": "2021-09-01T11:04:48+00:00"
    },
    {
        "message_state": "message-delivered",
        "happened_at": "2021-09-01T11:04:49+00:00"
    },
    {
        "message_state": "message-read",
        "happened_at": "2021-09-01T11:06:32+00:00"
    }
]

Example response (401):

{
    "error": "Invalid API Key Provided"
}

Example response (404):

{
    "error": "Message not found"
}

Check message history via this path.

POST v1/message-history

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
messageId	String	required	A unique key returned for every message sent

Note-
The messageId is returned for every HSM/template and session message that is sent.

OTP Service

APIs for using OTP as a Service

Generate OTP

[Request for an OTP.]

Example request:

curl -X POST \
    "https://api.tellephant.com/v1/send-otp" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"ABCDEFGHIJKLMNOPQRSTUVWXYZ","to":919999999999,"organisation_name":"Aiyo Labs"}'

const url = new URL(
    "https://api.tellephant.com/v1/send-otp"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "organisation_name": "Aiyo Labs"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.tellephant.com/v1/send-otp',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
            'to' => 919999999999,
            'organisation_name' => 'Aiyo Labs',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.tellephant.com/v1/send-otp'
payload = {
    "apikey": "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
    "to": 919999999999,
    "organisation_name": "Aiyo Labs"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (201):

{
    "success": true,
    "otpId": "CAGHDVFHVFUDUYRFGUFJYR"
}

Example response (422):

{
    "status": false,
    "error": {
        "apikey": [
            "The apikey field is required."
        ],
        "to": [
            "The to field is required."
        ],
        "organisation_name": [
            "The organisation_name field is required."
        ]
    }
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

Example response (401):

{
    "status": false,
    "error": "Please subscribe to addon first"
}

Example response (403):

{
    "status": false,
    "error": "Balance Low! Please recharge!"
}

HTTP Request

POST v1/send-otp

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
to	integer	required	to send OTP to.
organisation_name	String	required	Name of the organisation.

Validate the OTP

[Verify the OTP if it's correct]

Example request:

curl -X POST \
    "https://api.tellephant.com/v1/validate-otp" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"pi","otpId":"CAGHDVFHVFUDUYRFGUFJYR","otp":123456}'

const url = new URL(
    "https://api.tellephant.com/v1/validate-otp"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "pi",
    "otpId": "CAGHDVFHVFUDUYRFGUFJYR",
    "otp": 123456
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.tellephant.com/v1/validate-otp',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'pi',
            'otpId' => 'CAGHDVFHVFUDUYRFGUFJYR',
            'otp' => 123456,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.tellephant.com/v1/validate-otp'
payload = {
    "apikey": "pi",
    "otpId": "CAGHDVFHVFUDUYRFGUFJYR",
    "otp": 123456
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": true,
    "message": "OTP is valid"
}

Example response (200):

{
    "success": false,
    "message": "OTP is either expired or already used."
}

Example response (200):

{
    "success": false,
    "message": "Invalid OtpId Provided."
}

Example response (200):

{
    "success": false,
    "message": "OTP does not match."
}

Example response (422):

{
    "status": false,
    "error": {
        "apikey": [
            "The apikey field is required."
        ],
        "otpId": [
            "The otpId field is required."
        ],
        "otp": [
            "The otp field is required."
        ]
    }
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

HTTP Request

POST v1/validate-otp

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
otpId	String	required	OTP ID Received.
otp	integer	required	OTP to verify.

Webhook Management

APIs for managing account level information

Get Webhooks

[Get the current webhooks]

Example request:

curl -X POST \
    "https://app.tellephant.com/api/v2/user/webhook" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"CAGHDVFHVFUDUYRFGUFJYR"}'

const url = new URL(
    "https://app.tellephant.com/api/v2/user/webhook"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "CAGHDVFHVFUDUYRFGUFJYR"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.tellephant.com/api/v2/user/webhook',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'CAGHDVFHVFUDUYRFGUFJYR',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://app.tellephant.com/api/v2/user/webhook'
payload = {
    "apikey": "CAGHDVFHVFUDUYRFGUFJYR"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": true,
    "webhooks": {
        "delivery_response": {
            "url": "https:\/\/requestbin.com\/r\/XXXXXXXX",
            "status": false
        },
        "incoming_message": {
            "url": "https:\/\/requestbin.com\/r\/XXXXXXXXX",
            "status": true
        }
    }
}

Example response (422):

{
    "status": false,
    "error": {
        "apikey": [
            "The apikey field is required."
        ]
    }
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

HTTP Request

POST api/v2/user/webhook

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.

Update Webhooks

[Update the current webhooks]

Example request:

curl -X POST \
    "https://app.tellephant.com/api/v2/user/webhook/update" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"apikey":"CAGHDVFHVFUDUYRFGUFJYR","webhook_type":"delivery_response","webhook_endpoint":"\"https:\/\/requestbin.com\/r\/xxxxxxxx\"","webhook_status":"true"}'

const url = new URL(
    "https://app.tellephant.com/api/v2/user/webhook/update"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "apikey": "CAGHDVFHVFUDUYRFGUFJYR",
    "webhook_type": "delivery_response",
    "webhook_endpoint": "\"https:\/\/requestbin.com\/r\/xxxxxxxx\"",
    "webhook_status": "true"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.tellephant.com/api/v2/user/webhook/update',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'apikey' => 'CAGHDVFHVFUDUYRFGUFJYR',
            'webhook_type' => 'delivery_response',
            'webhook_endpoint' => '"https://requestbin.com/r/xxxxxxxx"',
            'webhook_status' => 'true',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://app.tellephant.com/api/v2/user/webhook/update'
payload = {
    "apikey": "CAGHDVFHVFUDUYRFGUFJYR",
    "webhook_type": "delivery_response",
    "webhook_endpoint": "\"https:\/\/requestbin.com\/r\/xxxxxxxx\"",
    "webhook_status": "true"
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": true,
    "message": "Webhook successfully updated."
}

Example response (422):

{
    "status": false,
    "error": {
        "apikey": [
            "The apikey field is required."
        ],
        "webhook_type": [
            "The webhook type field is required."
        ],
        "webhook_endpoint": [
            "The webhook endpoint field is required."
        ],
        "webhook_status": [
            "The webhook status field is required."
        ]
    }
}

Example response (401):

{
    "status": false,
    "error": "Invalid API Key Provided"
}

HTTP Request

POST api/v2/user/webhook/update

Body Parameters

Parameter	Type	Status	Description
apikey	String	required	API KEY Provided.
webhook_type	String	required	Webhook Type Provided.
webhook_endpoint	Url	required	Webhook Endpoint Provided.
webhook_status	Boolean	required	Webhook Status Provided.

Message Delivery Response

Message Accepted Response

{ "messageId": "60003fae6203e5098b751213", "status": "accepted", "timestamp": "2021-01-14T12:57:20.032134Z" }

Message Delivery Response

{ "messageId": "60003fae6203e5098b751213", "status": "delivered", "timestamp": "2021-01-14T12:57:20.253171Z" }

Message Seen Response

{ "messageId": "60003fae6203e5098b751213", "status": "seen", "timestamp": "2021-01-14T12:57:45Z" }

Note: For every WhatsApp message sent, there are three hits made to your webhook url i.e. (accepted, delivered and seen).

Incoming Payload (Text)

{ "messageId": "600042f62905c2668e678deb", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-14T13:11:17Z", "content_type": "text", "text": "Message_body", "received_at": "2021-01-14T13:11:17Z" }

Note: for every WhatsApp text message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.

Incoming Payload (Image)

{ "messageId": "6000442d78789049501796f9", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-14T13:16:28Z", "content_type": "image", "media_url": "file_url", "received_at": "2021-01-14T13:16:28Z" }

Note: for every WhatsApp image message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.

Incoming Payload (Document)

{ "messageId": "600044a8536544020b0a1346", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-14T13:18:30Z", "content_type": "document", "media_url": "file_url", "filename": "file_name.pdf", "caption": "file_caption", "received_at": "2021-01-14T13:18:30Z" }

Note: for every WhatsApp pdf message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.

Incoming Payload (Sticker)

{ "messageId": "600138de6e99f9269c24252d", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-15T06:40:28Z", "content_type": "sticker", "media_url": "file_url", "received_at": "2021-01-15T06:40:28Z" }

Note: for every WhatsApp sticker message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.

Incoming Payload (Video)

{ "messageId": "60013953d0d9562caa25fee2", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-15T06:42:22Z", "content_type": "video", "media_url": "file_url", "received_at": "2021-01-15T06:42:22Z" }

Note: for every WhatsApp video message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.

Incoming Payload (Audio)

{ "messageId": "600139a3650de2794016f889", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-15T06:43:46Z", "content_type": "voice", "media_url": "file_url", "received_at": "2021-01-15T06:43:46Z" }

Note: for every WhatsApp audio message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.

Incoming Payload (Location)

{ "messageId": "600139f1d935a0795a64ef0c", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-15T06:45:04Z", "content_type": "location", "location": { "longitude": 77.0952894, "latitude": 28.6297149 }, "received_at": "2021-01-15T06:45:04Z" }

Note: for every WhatsApp location message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.

Incoming Payload (Contact)

{ "messageId": "60013a52d0d9562caa25fee6", "from": "Sender_number_with_country_code", "sender_name": "Sender_name", "to": "Recipient_number_with_country_code", "timestamp": "2021-01-15T06:46:42Z", "content_type": "contacts", "contacts": [ { "addresses": [], "emails": [], "ims": [], "name": { "firstName": "First_name", "middleName": "Middle_name", "lastName": "Last_name", "formattedName": "Full_Name" }, "org": { "company": "Company_Name" }, "phones": [ { "phone": "Number_with_country_code", "type": "Mobile", "waId": "formated_number" } ], "urls": [] } ], "received_at": "2021-01-15T06:46:42Z" }

Note: for every WhatsApp contact message sent by the user to your Official WhatsApp Business Account, the incoming response is as shown above.