This collection contains the API endpoints for Amane3 Connect, a messaging solution that allows businesses to send emails, SMS, and WhatsApp messages efficiently. The endpoints cover various functionalities such as sending bulk emails, bulk sms, bulk WhatsApp managing contacts, and checking all their status.
\nSend Email: email/send
Email Delivery: get/email/{{uid}}
Send SMS: sms/send
SMS Delivery: get/sms/{{uid}}
Send Whatsapp: whatsapp/send
Whatsapp Delivery: get/whatsapp/{{uid}}
Each request in this collection includes the necessary headers and body parameters to interact with the Amane3 Connect API. Please replace placeholders with actual data.
\nThe API requires an API key for authentication. Ensure you include the Api-key header with your valid API key in each request.
This endpoint is used to send emails.
\ncontact (array of objects, required): An array containing objects with the following parameters:
subject (string, required): The subject of the email.
email (string, required): The recipient's email address.
message (string, required): The content of the email.
The response is in JSON format and follows the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"email_logs\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"uid\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThe response includes the following properties:
\nstatus (string): The status of the email sending process.
email_logs (array of objects): An array containing logs for each email sent, with the following parameters:
uid (string): The unique identifier for the email log.
email (string): The recipient's email address.
status (string): The status of the email delivery.
created_at (string): The timestamp of when the email was sent.
message (string): Additional information or message related to the email sending process.
The endpoint retrieves email details for a specific user identified by their unique ID.
\nThe response returned is a JSON object with the following properties:
\nstatus (string): Indicates the status of the request.
email_logs (object): Contains the email log details with the following properties:
uid (string): Unique identifier for the email log.
email (string): Email address associated with the log.
content (string): Content of the email.
status (string): Status of the email log.
updated_at (string): Timestamp indicating when the email log was last updated.
The response can be used as a JSON schema for the structure of the data returned by the API endpoint.
\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, 'https://amane3.tanacom.io/api/get/email/{{uid}}');\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\n$response = curl_exec($ch);\nif (curl_getinfo($ch, CURLINFO_HTTP_CODE) === 201) {\n $data = json_decode($response, true);\n // Process the $data as per your requirement\n} else {\n echo 'Request failed: HTTP status code - ' . curl_getinfo($ch, CURLINFO_HTTP_CODE);\n}\ncurl_close($ch);\n?>\n\nThe response returned is a JSON object with the following properties:
\nstatus (string): Indicates the status of the request.
email_logs (object): Contains the email log details with the following properties:
uid (string): Unique identifier for the email log.
email (string): Email address associated with the log.
content (string): Content of the email.
status (string): Status of the email log.
updated_at (string): Timestamp indicating when the email log was last updated.
The response can be used as a JSON schema for the structure of the data returned by the API endpoint.
\n// Assuming $response contains the JSON response from the API\n$responseArray = json_decode($response, true);\n// Accessing the email logs\n$emailLogs = $responseArray['email_logs'];\n// Accessing specific properties\n$uid = $emailLogs['uid'];\n$email = $emailLogs['email'];\n$content = $emailLogs['content'];\n$status = $emailLogs['status'];\n$updatedAt = $emailLogs['updated_at'];\n// Use the retrieved email log details as needed\n?>\n\nThe response returned is a JSON object with the following properties:
\nstatus (string): Indicates the status of the request.
\nemail_logs (object): Contains the email log details with the following properties:
\nuid (string): Unique identifier for the email log.
\nemail (string): Email address associated with the log.
\ncontent (string): Content of the email.
\nstatus (string): Status of the email log.
\nupdated_at (string): Timestamp indicating when the email log was last updated.
\nThe response can be used as a JSON schema for the structure of the data returned by the API endpoint.
\n","urlObject":{"path":["email","{{uid}}"],"host":["https://amane3.tanacom.io/api/get"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4abdf57-0721-43d3-9def-e7b805d15907"},{"name":"SendSMS","id":"bfee0b3e-5a06-4ee5-bbce-179ca167a5a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Api-key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": [\n {\n \"number\": \"phone number 1\",\n \"body\": \"Welcome to Amane3 Connect\",\n \"sms_type\": \"plain\"\n },\n {\n \"number\": \"phone number 2\",\n \"body\": \"Your Subscription is Confirmed\",\n \"sms_type\": \"unicode\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://amane3.tanacom.io/api/sms/send","description":"This API endpoint allows you to send SMS messages. The request should be sent as an HTTP POST to https://amane3.tanacom.io/api/sms/send with a JSON payload in the raw request body type. The payload should include an array of contacts, where each contact object contains the recipient's number, the message body, and the type of SMS.
\ncontact (array): An array of objects containing the following parameters for each contact:
number (string): The recipient's phone number.
body (string): The content of the SMS message.
sms_type (string): The type of SMS.
Upon successful execution, the API returns a status code of 201 and a JSON response with the following structure:
\n{\n \"status\": \"\",\n \"sms_logs\": [\n {\n \"uid\": \"\",\n \"number\": \"\",\n \"status\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"message\": \"\"\n}\n\nstatus (string): The status of the SMS sending process.
sms_logs (array): An array of objects containing details about the sent SMS messages, including unique identifiers, recipient numbers, status, and creation timestamps.
uid (string): Unique identifier for the SMS log.
number (string): Recipient's phone number.
status (string): Status of the SMS message.
created_at (string): Timestamp of when the SMS message was created.
message (string): Additional information or message related to the response.
The endpoint makes an HTTP GET request to retrieve SMS details for a specific user identified by their unique ID.
\nMethod: GET
\nEndpoint: https://amane3.tanacom.io/api/get/sms/{{uid}}
The response returned is a JSON object with the following properties:
\nstatus (string): Indicates the status of the request.
sms_logs (object): Contains the SMS log details with the following properties:
uid (string): Unique identifier for the SMS log.
number (string): Phone number associated with the log.
content (string): Content of the SMS.
status (string): Status of the SMS log.
updated_at (string): Timestamp indicating when the SMS log was last updated.
The response can be used as a JSON schema for the structure of the data returned by the API endpoint.
\n","urlObject":{"path":["sms","{{uid}}"],"host":["https://amane3.tanacom.io/api/get"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b78a4f8-e187-47f9-b954-127be7301bea"},{"name":"SendWhatsapp","id":"5457286b-36b0-4026-8965-c3a1962933e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Api-key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact\": [\n {\n \"number\": \"phone 1\",\n \"message\": \"Welcome to Amane3 Connect\"\n },\n {\n \"number\": \"phone 2\",\n \"message\": \"Welcome to Amane3 Connect\",\n \"media\": \"image\",\n \"url\": \"https://example.com/image.jpeg\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://amane3.tanacom.io/api/whatsapp/send","description":"The API endpoint allows you to send SMS messages via WhatsApp. The request should be sent as an HTTP POST to https://amane3.tanacom.io/api/whatsapp/send with a JSON payload in the raw request body type. The payload should include an array of contacts, where each contact object contains the recipient's number and the message body.
\ncontact (array): An array of objects containing the following parameters for each contact:
number (string): The recipient's phone number.
message (string): The content of the WhatsApp message.
The API returns a status code of 201 upon successful execution, and a JSON response with the following structure:
\n{\n \"status\": \"\",\n \"whatsapp_logs\": [\n {\n \"uid\": \"\",\n \"to\": \"\",\n \"status\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"message\": \"\"\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"whatsapp_logs\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"uid\": {\n \"type\": \"string\"\n },\n \"to\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\"\n },\n \"created_at\": {\n \"type\": \"string\"\n }\n }\n }\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n}\n\nThe endpoint makes an HTTP GET request to retrieve WhatsApp details for a specific user identified by their unique ID.
\nMethod: GET
\nEndpoint: https://amane3.tanacom.io/api/get/whatsapp/{{uid}}
This request does not contain a request body.
\nThe response returned is a JSON object with the following properties:
\nstatus (string): Indicates the status of the request.
whats_log (object): Contains the WhatsApp log details with the following properties:
uid (string): Unique identifier for the WhatsApp log.
number (string): Phone number associated with the log.
content (string): Content of the WhatsApp message.
status (string): Status of the WhatsApp log.
updated_at (string): Timestamp indicating when the WhatsApp log was last updated.
The response can be used as a JSON schema for the structure of the data returned by the API endpoint.
\n","urlObject":{"path":["whatsapp","{{uid}}"],"host":["https://amane3.tanacom.io/api/get"],"query":[],"variable":[]}},"response":[],"_postman_id":"df57a244-416b-4389-8c7b-3a99a213cac4"}],"event":[{"listen":"prerequest","script":{"id":"b233a5eb-8e01-4ebb-8546-c021e68adb2b","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"f98b052c-09c2-492a-bcaf-2eac37bde1cd","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"api_endpoint","value":"https://amane3.tanacom.io/api/"},{"key":"api_key","value":"your-api-key"},{"key":"content-type","value":"application/json"},{"key":"uid","value":"{{uid}}"}]}