Essayer
Recommended Services
Dev API
Supported Scripts

Bienvenue dans la documentation de Bwatmesaj.

Familiarisez-vous avec nos API et ressources techniques dans vos langages préférés

SMS API 

L'API SMS de Bwatmesaj vous permet d'envoyer et de recevoir des messages SMS vers et depuis n'importe quel pays dans le monde via une API REST. Chaque message est identifié par un ID aléatoire unique, permettant aux utilisateurs de vérifier à tout moment le statut d'un message grâce à l'endpoint fourni.

API Endpoint
https://main.bwatmesaj.com/api/v3/sms/send

Paramètres
ParamètresRequisDescription
Autorisation
Oui
Lors de l'appel à notre API, envoyez votre jeton API avec le type d'authentification défini comme Bearer (Example: Authorization: Bearer {api_token})
Accepter
Oui
Définir sur application/json
Envoyer un SMS sortant

L'API SMS programmable de Bwatmesaj vous permet d'envoyer des messages SMS de manière programmatique depuis votre application web. Tout d'abord, vous devez créer un nouvel objet message. Bwatmesaj renvoie l'objet message créé à chaque requête.

Envoyez votre premier message SMS avec cet exemple de requête.

API Endpoint

https://main.bwatmesaj.com/api/v3/sms/send

Paramètres
ParamètresRequisTypeDescription
recipient
Oui
stringNumber to send message. Utilisez une virgule. to send multiple numbers. Ex. 31612345678,8801721970168
sender_id
Oui
stringL'expéditeur du message. Cela peut être un numéro de téléphone (y compris l'indicatif du pays) ou une chaîne alphanumérique. Dans le cas d'une chaîne alphanumérique, la longueur maximale est de 11 caractères.
type
Oui
stringLe type du message. Pour un message texte, vous devez insérer Plein comme type de SMS
message
Oui
stringLe contenu du message SMS.
schedule_time
Non
datetimeLa date et l'heure programmées du message au format RFC3339. (Y-m-d H:i)
dlt_template_id
Non
stringL'ID de votre modèle de contenu DLT (Technologie de registre distribué) enregistré

Exemple de requête pour une seule liste de contacts

curl -X POST https://main.bwatmesaj.com/api/v3/sms/send \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
Exemple de requête pour plusieurs listes de contacts
PHP
curl -X POST https://main.bwatmesaj.com/api/v3/sms/send \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678,880172145789",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "sms reports with all details",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Envoyer une campagne en utilisant une liste de contacts

L'API SMS programmable de Bwatmesaj vous permet d'envoyer des campagnes de manière programmatique depuis votre application web. Tout d'abord, vous devez créer un nouvel objet message. Bwatmesaj renvoie l'objet message créé à chaque requête.

Envoyez votre première campagne en utilisant une liste de contacts avec cet exemple de requête

API Endpoint

Markup
https://main.bwatmesaj.com/api/v3/sms/campaign
Paramètres
ParamètresRequisTypeDescription
contact_list_id
Oui
stringListe de contacts à qui envoyer le message. Utilisez une virgule. Utilisez une virgule pour envoyer plusieurs listes de contacts. Par exemple : 6415907d0d7a6,6415907d0d37a
sender_id
Oui
stringL'expéditeur du message. Cela peut être un numéro de téléphone (y compris l'indicatif du pays) ou une chaîne alphanumérique. Dans le cas d'une chaîne alphanumérique, la longueur maximale est de 11 caractères.
type
Oui
stringLe type du message. Pour un message texte, vous devez insérer Plein comme type de SMS
message
Oui
stringLe contenu du message SMS.
schedule_time
Non
datetimeLa date et l'heure programmées du message au format RFC3339. (Y-m-d H:i)
dlt_template_id
Non
stringL'ID de votre modèle de contenu DLT (Technologie de registre distribué) enregistré
Exemple de requête pour une seule liste de contacts
PHP
curl -X POST https://main.bwatmesaj.com/api/v3/sms/campaign \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d37a",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
Exemple de requête pour plusieurs listes de contacts
PHP
curl -X POST https://main.bwatmesaj.com/api/v3/sms/campaign \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d37a,6415907d0d7a6",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "campaign reports with all details",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Voir un SMS

Vous pouvez utiliser l'API SMS de Bwatmesaj pour récupérer les informations d'un message SMS entrant ou sortant existant.

Vous devez uniquement fournir l'identifiant unique du message qui a été renvoyé lors de la création ou de la réception.

API Endpoint

Markup
https://www.main.bwatmesaj.com/api/v3/sms/{uid}
Paramètres
ParamètresRequisTypeDescription
uid
Oui
stringUn identifiant unique aléatoire qui est créé sur la plateforme Bwatmesaj et renvoyé lors de la création de l'objet.
Example request
PHP
curl -X GET https://main.bwatmesaj.com/api/v3/sms/606812e63f78b \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "sms data with all details",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Voir tous les messages

API Endpoint

Markup
https://www.main.bwatmesaj.com/api/v3/sms/
Example request
PHP
curl -X GET https://main.bwatmesaj.com/api/v3/sms \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "sms reports with pagination",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

Contacts API

L'API Contacts de Bwatmesaj vous aide à gérer les contacts identifiés par un ID unique aléatoire. À l'aide de cet ID, vous pouvez créer, afficher, mettre à jour ou supprimer des contacts. Cette API fonctionne comme une collection de contacts spécifiques aux clients, vous permettant de les regrouper et d'attribuer des valeurs personnalisées que vous pouvez ensuite utiliser lors de l'envoi de messages SMS avec des modèles

L'API Contacts utilise les verbes HTTP et une structure de point de terminaison RESTful avec une clé d'accès utilisée comme autorisation API. Les charges utiles des requêtes et des réponses sont formatées en JSON avec un encodage UTF-8 et des valeurs encodées en URL.

API Endpoint

Markup
https://main.bwatmesaj.com/api/v3/contacts
Paramètres
ParamètresRequisDescription
Autorisation
Oui
Lors de l'appel à notre API, envoyez votre jeton API avec le type d'authentification défini comme Bearer (Example: Authorization: Bearer {api_token})
Accepter
Oui
Définir sur application/json
Créer un contact

Crée un nouvel objet contact. Bwatmesaj renvoie l'objet contact créé à chaque requête.

API Endpoint

Markup
https://www.main.bwatmesaj.com/api/v3/contacts/{group_id}/store
Paramètres
ParamètresRequisTypeDescription
group_id
Oui
stringGroupes de contacts uid
PHONE
Oui
numberThe phone number of the contact.
OTHER_FIELDS
Non
stringAll Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)
Example request
PHP
curl -X POST https://main.bwatmesaj.com/api/v3/contacts/6065ecdc9184a/store \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View a contact

Retrieves the information of an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation or receiving.

API Endpoint

Markup
https://www.main.bwatmesaj.com/api/v3/contacts/{group_id}/search/{uid}
Paramètres
ParamètresRequisTypeDescription
group_id
Oui
stringGroupes de contacts uid
uid
Oui
stringContact uid
Example request
PHP
curl -X POST https://main.bwatmesaj.com/api/v3/contacts/6065ecdc9184a/search/606732aec8705 \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Update a contact

Updates an existing contact. You only need to supply the unique uid of contact and contact group uid that was returned upon creation.

API Endpoint

Markup
https://www.main.bwatmesaj.com/api/v3/contacts/{group_id}/update/{uid}
Paramètres
ParamètresRequisTypeDescription
group_id
Oui
stringGroupes de contacts uid
uid
Oui
stringContact uid
PHONE
Oui
numberThe phone number of the contact.
OTHER_FIELDS
Non
stringAll Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)
Example request
PHP
curl -X PATCH https://main.bwatmesaj.com/api/v3/contacts/6065ecdc9184a/update/606732aec8705 \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Delete a contact

Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.

API Endpoint

Markup
https://www.main.bwatmesaj.com/api/v3/contacts/{group_id}/delete/{uid}
Paramètres
ParamètresRequisTypeDescription
group_id
Oui
stringGroupes de contacts uid
uid
Oui
stringContact uid
Example request
PHP
curl -X DELETE https://main.bwatmesaj.com/api/v3/contacts/6065ecdc9184a/delete/606732aec8705 \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View all contacts in group

API Endpoint

Markup
https://www.main.bwatmesaj.com/api/v3/contacts/{group_id}/all
Paramètres
ParamètresRequisTypeDescription
group_id
Oui
stringGroupes de contacts uid
Example request
PHP
curl -X POST https://main.bwatmesaj.com/api/v3/contacts/6065ecdc9184a/all \
-H 'Authorization: Bearer 13|4j99SlsIaRf5Zh2X5QIFAFRREuPCMqBYsSBGFnbP5fbfe1ca' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Retour

Renvoie un objet contact si la requête a réussi.

JSON
{
    "status": "success",
    "data": "contacts data with pagination",
}

Si la requête échoue, un objet d'erreur sera retourné.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

Powered by
►
Necessary cookies enable essential site features like secure log-ins and consent preference adjustments. They do not store personal data.
None
►
Functional cookies support features like content sharing on social media, collecting feedback, and enabling third-party tools.
None
►
Analytical cookies track visitor interactions, providing insights on metrics like visitor count, bounce rate, and traffic sources.
None
►
Advertisement cookies deliver personalized ads based on your previous visits and analyze the effectiveness of ad campaigns.
None
Powered by
CHAT