API Management

API Management, our developer settings where you can explore what all Chatman API offers and utilize it to its full potential. In short, this is where you get public APIs for programmatically accessing Chatman.

Also, this is from where you can access the Postman collection.

To access public APIs for Chatman, tap the link as shown in the image below.

Chatman public collection includes numerous public APIs to access Chatman programmatically.

1. Contacts

2. Segments

3. Events

4. Journey

5. Send Message

Contacts

This includes all the contact related functions such as first_name, last_name, email, date of birth, gender, city, state, whatsapp_opted etc. The different API in Contacts are:

GET - Get Contacts List

This API allows you to retrieve a list of contacts from the audience table. You can specify the mode as 'all' to get all records or use 'new' and 'modified' modes to get updated contacts within a specified time range.

Other parameters include start_time, end_time, limit (number of records per page), and more.

GET - Get Multiple Contacts Details

With this API, you can fetch details for multiple contacts at once by providing a comma-separated list of contact wa_ids, this should be formed by combining the country code and phone number.

GET - Get Contact Details

This API will help obtain detailed information for an individual contact, providing specific details about a single user.

POST - Add Contact

When creating a new contact, this API requires mandatory information such as the phone_number and country_code, and system_attributes including first_name and email, with other attributes being optional.

The optional information that you can provide are: external_customer_id (a unique ID on your platform), custom_attributes and user_tags.

POST - Check Contact

The API checks whether a given phone number is a valid WhatsApp phone number.

GET - Check Contact Identity

The purpose of this API is to check the WhatsApp hash associated with a contact.

PATCH - Update Contact Identity

This API enables the update of the WhatsApp hash for a specific contact.

POST - Update Contact

The API updates contacts. It requires mandatory information like phone_number and country_code and optional information like .external_customer_id, system_attributes, custom_attributes and user_tags

Segment

This includes all the sgement related functions. The different APIs in Segments are:

GET - Get Segments List

This API allows you to retrieve a list of segments, including both live and static segments. You can use filters such as limit (specifying the number of segments to retrieve), search_key (to filter segments based on a search term), segment_type (to distinguish between live and static segments), and after.

POST - Create Segment

With this API, you can programmatically create live segments. Provide a segment_name for your new segment and include users in the segment using one of multiple ways: user_id (UUID, optional), wa_id (WhatsApp ID), email, or external_customer_id (optional, a unique ID on your platform).

POST - Evaluate Segment

This API is used to evaluate users within a segment.

POST - Subscribe to a Segment

Use this API to add a user to the subscribed_users list for a segment. Provide a list of user_ids, where user_id is the primary key of the user in our system, referenced by Customer Id or biz_whatsapp_user_id.

POST - Unsubscribe from a Segment

This API is designed to unsubscribe a user from a segment. It requires a list of user_ids, where user_id is the primary key of the user in your system, referenced by Customer Id or biz_whatsapp_user_id.

Events

It includes all the event-related APIs.

GET - Get All Events for a User

You get a list of all events associated with a specific user.

It has four categories system attribute, system event, custom event and campaign event, each with a set of APIs.

System Attribute

GET - Get System Attribute Types

This API is utilized to retrieve values for a specific user event. It provides information related to system attribute types, allowing you to fetch and understand the details associated with user events.

POST - Evaluate Chat Status

With this API, you can obtain values for a particular event related to the chat status of a user.

POST - Evaluate User Status

This API is used to get values for a particular event associated with a user's status.

System Event

GET - Get System Events

Use this API when you want to system events specific to a user.

POST - Evaluate User System Events

With this API, you can evaluate information about user-specific system events.

Custom Events

When creating or triggering custom events, various data types are supported including: integer, string, float, Boolean, list, date, datetime, json and uuid. The APIs under custom event are:

GET - Get Custom Triggered Events

This API is used to get a list of custom events that have been triggered.

GET - Get Specific Custom Triggered Event

With this API, you can get details of a specific custom event that has been triggered.

POST - Trigger Custom Event

This API allows you to programmatically trigger a custom event.

Custom event also has some APIs for different event types, they are:

GET - Get Custom Events

This API is used to get information about triggered custom events.

POST - Create Custom Event Type

With this API, you can create a new custom event type within the system. To do this, you need to provide the following information in the request body:

• event_name: Specify the name you want to assign to your custom event.

• attributes: Include all the necessary parameters and data types for the custom event in the request body.

Campaign Events

GET - Get Campaign Events by Campaign ID

This API is used to get campaign events based on a specific campaign ID.

Journey

It has all the public APIs related to the journey.

GET - Get All Journey

This API is utilized to retrieve information about all journeys available for a given phone number. The request supports pagination, so you can include parameters such as limit and after.Additionally, you can use the search_key parameter to search among the available journeys.

GET - Get All Journey Users

Use this API to obtain a list of all users within a specific journey. Provide the journey ID for which you want to retrieve user information. The API endpoint would typically look like v1/public-apis/<journey_id>/users/.

DELETE - Delete Journey

This API allows you to delete a particular journey by passing its ID as a parameter. For example, the endpoint could be v1/public-apis/delete-journey/<journey_id>.

Send Message

It includes all the APIs that you can utilize while sending messages.

POST - Send Text Message

Use this API to send a text message.

POST - Send List Message

This API is designed to send a list message.