Convers8 Developers

Appearance

v1.0.0

Convers8 API​

Convers8 API provides a comprehensive set of endpoints for managing WhatsApp communications, including messaging, contacts, and templates.

Contact​

Convers8 Support/support@convers8.chat

Servers​

https://waba-v1.convers8.africaProduction Server

Send Text Message​

POST
/whatsapp/message/text

Send a text message to a specified contact.

Authorizations​

bearerAuth
TypeHTTP (bearer)

Request Body​

JSON
{
"to": "string",
"name": "string",
"content": {
"text": "string"
}
}

Responses​

Message sent successfully
application/json
JSON
{
"message_id": "string",
"body": "string",
"type": "string",
"timestamp": "string",
"metadata": {
},
"media_url": "string"
}

Playground​

Authorization
Body
JSON

Samples​

Send Media Message​

POST
/whatsapp/message/media

Send a media message (image, document, video, etc.) to a specified contact.

Authorizations​

bearerAuth
TypeHTTP (bearer)

Request Body​

JSON
{
"to": "string",
"name": "string",
"content": {
"type": "string",
"url": "string",
"caption": "string"
}
}

Responses​

Media message sent successfully
application/json
JSON
{
"message_id": "string",
"body": "string",
"type": "string",
"timestamp": "string",
"metadata": {
},
"media_url": "string"
}

Playground​

Authorization
Body
JSON

Samples​

Send Interactive Message​

POST
/whatsapp/message/interactive

Send an interactive message with buttons or lists to a specified contact.

Authorizations​

bearerAuth
TypeHTTP (bearer)

Request Body​

JSON
{
"to": "string",
"name": "string",
"content": {
"type": "string",
"header": {
"type": "string",
"text": "string",
"url": "string"
},
"body": {
"text": "string"
},
"footer": {
"text": "string"
},
"action": {
"buttons": [
{
"type": "string",
"reply": {
"id": "string",
"title": "string"
}
}
],
"sections": [
{
"title": "string",
"rows": [
{
"id": "string",
"title": "string",
"description": "string"
}
]
}
]
}
}
}

Responses​

Interactive message sent successfully
application/json
JSON
{
"message_id": "string",
"body": "string",
"type": "string",
"timestamp": "string",
"metadata": {
}
}

Playground​

Authorization
Body
JSON

Samples​

Send Template Message​

POST
/whatsapp/message/template

Send a pre-approved template message to a specified contact.

Authorizations​

bearerAuth
TypeHTTP (bearer)

Request Body​

JSON
{
"to": "string",
"name": "string",
"content": {
"template_name": "string",
"language": {
"code": "string"
},
"components": [
{
"type": "string",
"parameters": [
{
"type": "string",
"text": "string",
"image": {
"link": "string"
},
"document": {
"link": "string"
},
"video": {
"link": "string"
}
}
]
}
]
}
}

Responses​

Template message sent successfully
application/json
JSON
{
"message_id": "string",
"body": "string",
"type": "string",
"timestamp": "string",
"metadata": {
}
}

Playground​

Authorization
Body
JSON

Samples​

Send Location Message​

POST
/whatsapp/message/location

Send a location message to a specified contact.

Authorizations​

bearerAuth
TypeHTTP (bearer)

Request Body​

JSON
{
"to": "string",
"contact": "string",
"content": {
"latitude": "string",
"longitude": "string",
"name": "string",
"address": "string"
}
}

Responses​

Location message sent successfully
application/json
JSON
{
"message_id": "string",
"body": "string",
"type": "string",
"timestamp": "string",
"metadata": {
}
}

Playground​

Authorization
Body
JSON

Samples​

Contacts​

Endpoints for managing contacts.

Operations​

GET/contacts

List contacts​

GET
/contacts

Retrieve a list of all contacts.

Authorizations​

bearerAuth
TypeHTTP (bearer)

Responses​

A list of contacts
application/json
JSON
[
{
"id": "string",
"name": "string",
"phone_number": "string"
}
]

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI