This API (Application Programming Interface) allows integration between your applications and the Atom Template sending service. This API allows:

This service allows sendingTemplate Messagesusing the Official WhatsApp number and thetemplateId.

When the sent number is already linked to a conversation, the message will be sent in the same and the sending confirmation will be immediate. Otherwise, confirmation will be awaited through the Official WhatsApp provider, so an immediate sending confirmation will not be provided.

Below we explain the parameters that must be included in the request, and others that can be added optionally:

| Parameter Name |

| Description |

| Data Type |

| Required |

| templateId |

| Identifier (ID) of the AtomChat Template Message |

| string |

| Yes |

| phoneNumber |

| Phone number to which the Template Message will be sent. It must be informed with the country code, without using the + sign |

| Correct: 50755667788 ✅ |

| Incorrect: +50555667788 ❌ |

| Incorrect: 55667788 ❌ |

| string |

| Yes |

| firstName |

| Customer's name |

| string |

| Yes |

| lastName |

| Customer's last name |

| string |

| Yes |

| assign |

| Indicates whether the conversation should be assigned to an Agent (with valuetrue). Otherwise, it will be assigned to the Bot |

| boolean |

| No. The default value isfalse |

| params |

| Collection of parameters with their respective values necessary for the use of the Template Message |

| {key: value}object |

| No |

The request to send Template Messages using the AtomChat API is performed as follows:

Connection Type

Public access via the Internet

Endpoint

Method

POST

Headers

Body

Code:200

Code:202

Code:400

Code:400

Code:400

Code:401

Code:401

Code:401

Code:500

This service allows you to get the details of a specific template.

Endpoint

Method:GET

Code:200

Code:404

Code:400