DoubleTick

https://docs.doubletick.io/docs
Admin
DoubleTick is an all-in-one WhatsApp API solution designed to supercharge marketing and customer...
Tokens:42,842
Snippets:356
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Success Response Example

Source: https://docs.doubletick.io/docs/get-groups

This is an example of a successful response when retrieving broadcast groups. It includes group details and pagination information.

```JSON
{
  "groups": [
    {
      "groupId": "group_id",
      "groupChatName": "broadcast_group_name",
      "memberCount": 5,
      "dateCreated": 1737568528728,
      "lastMessageAt": "2025-01-23T10:04:35.188Z",
      "groupType": "STATIC_SEGMENT",
      "isInternal": false
    }
  ],
  "paginationParams": {
    "hasMore": false
  }
}
```

--------------------------------

### Success Response for Wallet Balance

Source: https://docs.doubletick.io/docs/get-wallet-balance

This is an example of a successful response, showing your available balance and its currency code.

```json
{
    "balance": 10.34577189385891,
    "currencyCode": "INR"
}
```

--------------------------------

### Success Response Example (201)

Source: https://docs.doubletick.io/docs/get-team-member-details-1

This is an example of a successful response when retrieving team member details. It includes agent information, role, and reporting manager details.

```JSON
{
  "id": "agnet_id",
  "name": "agent_name",
  "phone": "agent_number",
  "email": null,
  "joinDate": "2025-02-14T04:35:15.535Z",
  "orgRoleId": "organization_role_id",
  "orgRoleName": "OWNER",
  "wabaRoles": [
    {
      "wabaName": "WhatsApp Business Name",
      "wabaNumber": "WhatsApp API Number",
      "roleName": "OWNER"
    }
  ],
  "isOrganizationOwner": false,
  "reportingManager": [
    {
      "id": "reporting_manager_id",
      "name": "reporting_manager_name",
      "email": "reporting_manager_email",
      "phone": "reporting_manager_number",
      "joinDate": "2023-08-25T13:14:26.037Z"
    }
  ]
}
```

--------------------------------

### Success Response Example

Source: https://docs.doubletick.io/docs/get-webhooks-1

This is an example of a successful response when retrieving webhooks. It includes webhook ID, URL, associated WABA numbers, event types, integration count, creator, and name.

```json
[
    {
        "webhookId": "webhook_id",
        "url": "webhook_url",
        "wabaNumbers": [
            "waba_number1",
            "waba_number2",
            "waba_number3"
        ],
        "eventTypes": [
            "MESSAGE_RECEIVED",
            "MESSAGE_STATUS_UPDATE"
        ],
        "integrationCount": "3",
        "createdBy": "creator_name",
        "name": "webhook_name"
    }
]
```

--------------------------------

### API Endpoint to Get All Roles

Source: https://docs.doubletick.io/docs/get-all-roles-1

Use this GET endpoint to retrieve a list of all available roles from the DoubleTick API.

```HTTP
GET https://public.doubletick.io/roles
```

--------------------------------

### Success Response Example

Source: https://docs.doubletick.io/docs/get-all-roles-1

This JSON structure represents a successful retrieval of roles, detailing each role's properties and associated permissions.

```JSON
[
  {
    "id": "role_id",
    "name": "role_name",
    "title": "role_title",
    "description": "role_description",
    "isCustomRole": false,
    "type": "ROLE_TYPE",
    "permissions": [
      {
        "id": "permissions_related_to_roles",
        "name": "permission_name",
        "description": "permission_description"
      },
      {
        "id": "permissions_related_to_roles",
        "name": "permission_name",
        "description": "permission_description"
      }
    ]
  }
]
```

--------------------------------

### Success Response Example

Source: https://docs.doubletick.io/docs/get-chat-window-status-1

A successful response indicates the chat window status, including whether it is open or closed.

```json
{
  "customerPhoneNumber": "customer_number",
  "wabaNumber": "your_waba_number",
  "isOpen": false
}
```

--------------------------------

### Send WhatsApp Template Message using Node.js

Source: https://docs.doubletick.io/docs/getting-started

This Node.js script demonstrates how to send a WhatsApp template message using the axios library. Ensure you have axios installed (`npm install axios`).

```javascript
const axios = require('axios');

const apiUrl = 'https://public.doubletick.io/whatsapp/message/template';
const apiKey = 'key_xxxxxxxxxx';

const payload = {
  messages: [
    {
      content: {
        language: 'en',
        templateName: 'template_name'
      },
      from: 'sender_number',
      to: 'customer_number'
    }
  ]
};

axios.post(apiUrl, payload, {
  headers: {
    'Authorization': `key ${apiKey}`,
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  }
})
.then(response => console.log(response.data))
.catch(error => console.error(error.response ? error.response.data : error.message));
```

--------------------------------

### Success Response Example

Source: https://docs.doubletick.io/docs/assign-custom-fields-andor-tags-to-customer

This JSON shows a successful assignment of custom fields and tags, detailing added and errored items, along with the customer ID.

```JSON
{
    "customFields": {
        "added": ["new field"],
        "errored": []
    },
    "tags": {
        "added": ["team lead"],
        "errored": []
    },
    "customerId": "customer_id"
}
```

--------------------------------

### Not Found Response Example

Source: https://docs.doubletick.io/docs/edit-template-1

If the specified template ID does not exist, a 'Not Found' response with a 404 status code will be returned.

```JSON
{
  "message": "error_message",
  "statusCode": 404
}
```

--------------------------------

### Get Wallet Balance API Endpoint

Source: https://docs.doubletick.io/docs/get-wallet-balance

Use this GET endpoint to retrieve your current wallet balance.

```http
GET https://public.doubletick.io/wallet/balance
```

--------------------------------

### Success Response Example (201)

Source: https://docs.doubletick.io/docs/remove-custom-fields-andor-tags-from-customer

This response indicates that the tags and/or custom fields were successfully removed. It lists the items removed and any that encountered errors.

```JSON
{
  "customFields": {
    "removed": ["new field1", "new field"],
    "errored": []
  },
  "tags": {
    "removed": ["team lead", "team member"],
    "errored": []
  }
}
```

--------------------------------

### Get Team

Source: https://docs.doubletick.io/docs/get-team-1

Retrieves a list of all team members, their roles, and reporting hierarchy.

```APIDOC
## GET /team

### Description
Retrieve a complete list of team members, including their roles and reporting hierarchy, using the DoubleTick API for efficient team management.

### Method
GET

### Endpoint
https://public.doubletick.io/team

### Request Headers
```json
{
  "Authorization": "YOUR_API_KEY"
}
```

### Response
#### Success Response (200)
- **data** (array) - List of agents in the organization.
  - **id** (string) - Unique identifier of the agent.
  - **name** (string) - Name of the agent.
  - **phone** (string) - Phone number of the agent.
  - **email** (string) - Email address of the agent.
  - **joinDate** (string) - Date and time when the agent joined (ISO format).
  - **reportingManager** (array) - List of managers assigned to the agent.
    - **id** (string) - Unique identifier of the reporting manager.
    - **name** (string) - Name of the reporting manager.
    - **phone** (string) - Phone number of the reporting manager.
    - **email** (string) - Email address of the reporting manager.
    - **joinDate** (string) - Date and time when the manager joined (ISO format).
  - **orgRoleName** (string) - Role of the agent within the organization.
  - **orgRoleId** (string) - Unique identifier for the organization role.
  - **isOrganizationOwner** (boolean) - Indicates whether the agent is the owner of the organization.

#### Response Example
```json
{
    "data": [
        {
            "id": "user_id",
            "name": "agent_name",
            "phone": "agent_number",
            "email": "agent_email_address",
            "joinDate": "2024-11-26T11:02:31.855Z",
            "reportingManager": [
                {
                    "id": "manager_id",
                    "name": "manager_name",
                    "phone": "manager_number",
                    "email": "manager_email",
                    "joinDate": "2023-08-25T13:14:26.037Z"
                }
            ],
            "orgRoleName": "TEAM_LEAD",
            "orgRoleId": "organization_role_id",
            "isOrganizationOwner": false
        }
    ]
}
```

#### Unauthorized (401)
```json
{
  "message": "Invalid public api key",
  "error": "Unauthorized",
  "statusCode": 401
}
```
```

--------------------------------

### Get Wallet Balance

Source: https://docs.doubletick.io/docs/get-wallet-balance

Retrieves the current wallet balance and currency code associated with the API key.

```APIDOC
## GET /wallet/balance

### Description
Retrieves the current wallet balance and currency code associated with the API key.

### Method
GET

### Endpoint
https://public.doubletick.io/wallet/balance

### Request Headers
```json
{
  "Authorization": "YOUR_API_KEY"
}
```

### Response
#### Success Response (200)
- **balance** (number) - Available wallet balance.
- **currencyCode** (string) - Currency of the balance (e.g., "INR" for Indian Rupee).

#### Response Example
```json
{
    "balance": 10.34577189385891,
    "currencyCode": "INR"
}
```

#### Error Response (401)
- **message** (string) - Error message indicating invalid API key.
- **error** (string) - General error type.
- **statusCode** (number) - HTTP status code.

#### Response Example
```json
{
    "message": "Invalid public api key",
    "error": "Unauthorized",
    "statusCode": 401
}
```
```

--------------------------------

### Success Response Structure

Source: https://docs.doubletick.io/docs/get-template

This is an example of a successful response when retrieving WhatsApp templates. It includes details like ID, name, language, category, components, buttons, status, creator, and associated phone number.

```json
[
  {
    "id": "template_id",
    "name": "your_template_name",
    "language": "en",
    "category": "MARKETING",
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Header Content"
      },
      {
        "type": "BODY",
        "text": "Body Content with placeholders"
      },
      {
        "type": "FOOTER",
        "text": "Footer Content"
      }
    ],
    "buttons": [
      {
        "type": "QUICK_REPLY",
        "text": "Button 1"
      }
    ],
    "status": "APPROVED",
    "createdBy": "creator_name",
    "wabaPhoneNumber": "your_waba_number"
  }
]
```

--------------------------------

### API Endpoint for Fetching Templates

Source: https://docs.doubletick.io/docs/get-template

Use this GET endpoint to retrieve WhatsApp templates. You can filter results using query parameters.

```http
GET https://public.doubletick.io/v2/templates
```

--------------------------------

### Example cURL Request for AI Bot Call

Source: https://docs.doubletick.io/docs/initiate-ai-bot-call

Use this cURL command to make a POST request to initiate an AI-powered voice call. Replace placeholders with your actual API key and desired phone numbers and agent name.

```Shell
curl --request POST \
  --url https://public.doubletick.io/v1/call/ai-bot \
  --header "Authorization: <your-api-key>" \
  --header "Content-Type: application/json" \
  --data '{ 
    "from": "+911234567890",
    "to": "+919876543210",
    "channel": "WHATSAPP",
    "aiAgentName": "agent_abc123"
  }'
```

--------------------------------

### Get Customer Details

Source: https://docs.doubletick.io/docs/get-customer-details-1

Fetches detailed information about a specific customer using their phone number or customer ID.

```APIDOC
## GET /customer/details

### Description
Retrieves detailed information about a customer, including their name, assigned user, phone number, and any custom fields associated with them.

### Method
GET

### Endpoint
`https://public.doubletick.io/customer/details`

### Query Parameters
- **phoneNumber** (string) - Required - The customer's phone number in international format.
- **customerId** (string) - Required - The unique ID of the customer.

### Request Headers
- **Authorization** (string) - Required - YOUR_API_KEY
- **Content-Type** (string) - Required - application/json

### Response
#### Success Response (200)
- **customer** (object) - Contains details about the customer.
  - **name** (string) - Name of the customer.
  - **assignedToUser** (string) - Name of the client assigned to the customer.
  - **phone** (string) - Customer’s phone number.
  - **assignedUserNumber** (string) - Phone number of the assigned client.
  - **customFields** (array of objects) - List of custom fields associated with the customer.
    - **id** (string) - Unique identifier of the custom field.
    - **name** (string) - Name of the custom field.
    - **value** (string) - Value stored in the custom field.
    - **type** (string) - Data type of the custom field.

### Response Example
```json
{
    "customer": {
        "name": "customer_name",
        "assignedToUser": "client_name",
        "phone": "customer_phone_number",
        "assignedUserNumber": "client_phone_number",
        "customFields": [
            {
                "id": "custom_field_id",
                "name": "message",
                "value": "2025-01-21T09:16:18.000Z",
                "type": "date"
            },
            {
                "id": "custom_field_id",
                "name": "message",
                "value": "2025-01-21T09:17:20.000Z",
                "type": "date"
            }
        ]
    }
}
```

### Error Handling
#### Bad Request (400)
```json
{
  "message": "error_message",
  "error": "Bad Request",
  "statusCode": 400
}
```
#### Unauthorized (401)
```json
{
  "message": "Invalid public api key",
  "error": "Unauthorized",
  "statusCode": 401
}
```
#### Not Found (404)
```json
{
  "message": "error_message",
  "statusCode": 404
}
```
```

--------------------------------

### Get All Roles

Source: https://docs.doubletick.io/docs/get-all-roles-1

Fetches a list of all available roles from the DoubleTick API. This is useful for understanding the available roles and their associated permissions for access control management.

```APIDOC
## GET /roles

### Description
Retrieve all available roles with the DoubleTick API, enabling comprehensive role-based access control and permission management.

### Method
GET

### Endpoint
https://public.doubletick.io/roles

### Request Headers
```json
{
  "Authorization": "YOUR_API_KEY",
  "Content-Type": "application/json"
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the role.
- **name** (string) - Name of the role.
- **title** (string) - Title associated with the role.
- **description** (string) - Detailed description of the role.
- **isCustomRole** (boolean) - Indicates if the role is a custom-created role.
- **type** (string) - Specifies the type of role.
- **permissions** (array) - List of permissions associated with the role.
  - **id** (string) - Unique identifier for the permission.
  - **name** (string) - Name of the permission.
  - **description** (string) - Description of what the permission allows.

#### Response Example
```json
[
  {
    "id": "role_id",
    "name": "role_name",
    "title": "role_title",
    "description": "role_description",
    "isCustomRole": false,
    "type": "ROLE_TYPE",
    "permissions": [
      {
        "id": "permissions_related_to_roles",
        "name": "permission_name",
        "description": "permission_description"
      },
      {
        "id": "permissions_related_to_roles",
        "name": "permission_name",
        "description": "permission_description"
      }
    ]
  }
]
```

#### Error Response (400)
- **message** (string) - Error message.
- **error** (string) - Error type.
- **statusCode** (integer) - HTTP status code.

#### Error Response (401)
- **message** (string) - Error message.
- **error** (string) - Error type.
- **statusCode** (integer) - HTTP status code.

#### Error Response (422)
- **message** (string) - Error message.
- **error** (string) - Error type.
- **statusCode** (integer) - HTTP status code.
```

--------------------------------

### Initiate AI Bot Call

Source: https://docs.doubletick.io/docs/initiate-ai-bot-call

Starts an outbound voice call that is fully handled by your configured AI agent. The AI agent manages the entire conversation automatically, so no WebRTC client or manual agent intervention is required.

```APIDOC
## POST /v1/call/ai-bot

### Description
Starts an outbound voice call that is fully handled by your configured AI agent. The AI agent manages the entire conversation automatically, so no WebRTC client or manual agent intervention is required.

### Method
POST

### Endpoint
https://public.doubletick.io/v1/call/ai-bot

### Authentication
Include your API key in the `Authorization` header.
Header| Value  
---|---  
Authorization| `<your-api-key>`  
Content-Type| `application/json`  

### Parameters
#### Request Body
- **from** (string) - Required - The phone number used to initiate the call. For `WHATSAPP` calls, provide your **WhatsApp Business Account (WABA)** number. For `PSTN` calls, provide your **PSTN-enabled phone number**. The number must be in E.164 format.
- **to** (string) - Required - Customer phone number in E.164 format. Example: `+919876543210`.
- **channel** (string) - Required - Calling channel. Supported values are `WHATSAPP` and `PSTN`.
- **aiAgentName** (string) - Required - Name of the active AI agent that should handle the call present on DoubleTick.

### Request Example
```json
{
  "from": "+911234567890",
  "to": "+919876543210",
  "channel": "WHATSAPP",
  "aiAgentName": "agent_abc123"
}
```

### Response
#### Success Response (200 OK)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains details about the initiated call.
  - **callId** (string) - Unique identifier for the initiated AI voice call.
  - **pstnPhoneNumber** (string) - Phone number used for the PSTN connection, when applicable.
- **customer** (object) - Information about the customer.
  - **name** (string) - Customer name.
  - **phoneNumber** (string) - Customer phone number.

#### Response Example
```json
{
  "success": true,
  "data": {
    "callId": "call_xyz789",
    "pstnPhoneNumber": "+911234567890"
  },
  "customer": {
    "name": "John Doe",
    "phoneNumber": "+919876543210"
  }
}
```

### Error Responses
- **400** - Invalid `channel` value or the specified AI agent is not configured.
- **401** - Invalid or missing API key.
- **403** - PSTN calling is not enabled for your organization.
- **422** - WABA number not found, coex number, or the customer is blocked.
- **429** - Rate limit exceeded. Check the `Retry-After` response header before retrying.
```

--------------------------------

### Retrieve All Registered Webhooks

Source: https://docs.doubletick.io/docs/get-webhooks-1

Use this GET endpoint to retrieve all registered webhooks. You can sort the results by name, URL, creator, or integration count, and specify the sort direction.

```http
GET https://public.doubletick.io/v2/webhooks?sortBy=name&sortDirection=ASC
```

--------------------------------

### Success Response Example (201)

Source: https://docs.doubletick.io/docs/get-chat-messages-1

This JSON structure represents a successful retrieval of chat messages, including message details, origin, sender information, and timestamps.

```json
{
  "messages": [
    {
      "message": {
        "text": "text_message",
        "messageType": "text"
      },
      "messageOriginType": "CUSTOMER",
      "id": "message_id",
      "sentCount": 0,
      "readCount": 0,
      "deliveryCount": 0,
      "erroredCount": 0,
      "senderId": "customer_id",
      "templateId": null,
      "repliesCount": 0,
      "unreadCount": 0,
      "noResponseCount": 0,
      "isFromAd": false,
      "messageMetadata": {
        "status": null
      },
      "linkAnalytics": null,
      "senderUser": {
        "id": null,
        "name": null,
        "imageUrl": "",
        "phoneNumber": null
      },
      "integrationId": "integration_id",
      "integrationDisplayName": "DoubleTick Demo",
      "messageTime": 1737612046032,
      "quickActionButtonStats": [],
      "cardButtonStats": [],
      "totalCount": 1,
      "integrationWabaNumber": "integrated_waba_number"
    }
  ]
}
```

--------------------------------

### Example Success Response for AI Bot Call

Source: https://docs.doubletick.io/docs/initiate-ai-bot-call

A 200 OK response indicates that the AI call has been successfully queued for processing. The response includes a unique callId for tracking and customer details.

```JSON
{
  "success": true,
  "data": {
    "callId": "call_xyz789",
    "pstnPhoneNumber": "+911234567890"
  },
  "customer": {
    "name": "John Doe",
    "phoneNumber": "+919876543210"
  }
}
```

--------------------------------

### Get Webhooks

Source: https://docs.doubletick.io/docs/get-webhooks-1

Retrieves a list of all registered webhooks. You can sort the results by name, URL, creator, or integration count, and specify the sorting direction.

```APIDOC
## GET /v2/webhooks

### Description
Retrieves a list of registered webhooks, including their event types and associated WABA numbers.

### Method
GET

### Endpoint
https://public.doubletick.io/v2/webhooks

### Query Parameters
- **sortBy** (string) - Optional - Sort webhooks by `name`, `url`, `createdBy`, or `integrationCount`. Default is `name`.
- **sortDirection** (string) - Optional - Sorting order: `ASC` (ascending) or `DESC` (descending). Default is `ASC`.

### Request Headers
- **Authorization** (string) - Required - YOUR_API_KEY

### Response
#### Success Response (200)
- **webhookId** (string) - Description not available in source.
- **url** (string) - Description not available in source.
- **wabaNumbers** (array) - Description not available in source.
- **eventTypes** (array) - Description not available in source.
- **integrationCount** (string) - Description not available in source.
- **createdBy** (string) - Description not available in source.
- **name** (string) - Description not available in source.

#### Response Example
```json
[
    {
        "webhookId": "webhook_id",
        "url": "webhook_url",
        "wabaNumbers": [
            "waba_number1",
            "waba_number2",
            "waba_number3"
        ],
        "eventTypes": [
            "MESSAGE_RECEIVED",
            "MESSAGE_STATUS_UPDATE"
        ],
        "integrationCount": "3",
        "createdBy": "creator_name",
        "name": "webhook_name"
    }
]
```

#### Error Response (400)
```json
{
  "message": "error_message",
  "error": "Bad Request",
  "statusCode": 400
}
```

#### Error Response (401)
```json
{
  "message": "Invalid public api key",
  "error": "Unauthorized",
  "statusCode": 401
}
```

#### Error Response (422)
```json
{
  "message": "invalid file type for audio: text/html; charset=utf-8",
  "error": "Unprocessable Entity",
  "statusCode": 422
}
```
```

--------------------------------

### API Endpoint for Customer Details

Source: https://docs.doubletick.io/docs/get-customer-details-1

Use this GET endpoint to retrieve specific customer details by providing their phone number or customer ID.

```HTTP
GET https://public.doubletick.io/customer/details?phoneNumber={customer_phone}&customerId={customer_id}
```

--------------------------------

### Get WhatsApp Templates

Source: https://docs.doubletick.io/docs/get-template

Fetches a list of WhatsApp templates based on the provided query parameters. You can filter templates by status, name, language, category, and WABA phone numbers.

```APIDOC
## GET /v2/templates

### Description
Retrieves a list of WhatsApp templates with optional filtering.

### Method
GET

### Endpoint
https://public.doubletick.io/v2/templates

### Headers
- **Authorization** (string) - Required - Your API Key
- **Content-Type** (string) - Required - application/json

### Query Parameters
- **status** (string) - Optional - The status of the templates (e.g., `APPROVED`, `REJECTED`, `PENDING`, `PAUSED` or `ALL`)
- **name** (string) - Optional - The name of the template
- **language** (string) - Optional - The language of the template. Defaults to `en`.
- **category** (string) - Optional - The category of the template (`MARKETING`, `UTILITY`)
- **wabaPhoneNumbers** (string) - Optional - The WhatsApp Business API phone numbers.
- **allWabaPhoneNumbers** (boolean) - Optional - If set to true, returns templates for all WABA Phone Numbers.

### Response
#### Success Response (200)
Returns an array of template objects.
```json
[
  {
    "id": "template_id",
    "name": "your_template_name",
    "language": "en",
    "category": "MARKETING",
    "components": [
      {
        "type": "HEADER",
        "format": "TEXT",
        "text": "Header Content"
      },
      {
        "type": "BODY",
        "text": "Body Content with placeholders"
      },
      {
        "type": "FOOTER",
        "text": "Footer Content"
      }
    ],
    "buttons": [
      {
        "type": "QUICK_REPLY",
        "text": "Button 1"
      }
    ],
    "status": "APPROVED",
    "createdBy": "creator_name",
    "wabaPhoneNumber": "your_waba_number"
  }
]
```
* `id` (string): Unique identifier of the template.
* `name` (string): Name of the template.
* `language` (string): Language code of the template.
* `category` (string): Category of the template.
* `components` (array): Defines different parts of the template.
  * `type` (string): Type of component.
  * `format` (string, optional): Format for the HEADER component.
  * `text` (string): Content of the component.
* `buttons` (array): Contains interactive buttons.
  * `type` (string): Type of button.
  * `text` (string): Label of the button.
* `status` (string): Current approval status of the template.
* `createdBy` (string): Name of the user who created the template.
* `wabaPhoneNumber` (string): The registered WhatsApp Business API phone number.

#### Bad Request (400)
```json
{
  "message": "error_message",
  "error": "Bad Request",
  "statusCode": 400
}
```

#### Unauthorized (401)
```json
{
  "message": "Invalid public api key",
  "error": "Unauthorized",
  "statusCode": 401
}
```
```

--------------------------------

### Initiate AI Bot Call Endpoint

Source: https://docs.doubletick.io/docs/initiate-ai-bot-call

This is the endpoint used to start an outbound AI-powered voice call. Ensure you include your API key in the Authorization header and set the Content-Type to application/json.

```HTTP
POST https://public.doubletick.io/v1/call/ai-bot
```

--------------------------------

### Bitrix24 Local Application Settings

Source: https://docs.doubletick.io/docs/bitrix24-integration-with-doubletick

Configure the settings for a local application in Bitrix24. Ensure you upload the DoubleTick ZIP file and assign the necessary permissions for the integration to function correctly.

```text
Menu item text: DoubleTick
Assign permissions: CRM (crm), Users (user), Application embedding (placement)
```

--------------------------------

### Get Chat Messages

Source: https://docs.doubletick.io/docs/get-chat-messages-1

Fetches chat messages for a given customer and WABA number. You can filter messages by specifying a start and end date.

```APIDOC
## GET /chat-messages

### Description
Retrieves WhatsApp chat messages for a specific customer associated with a given WhatsApp Business Account (WABA) number. This endpoint is useful for record-keeping and analyzing customer interactions.

### Method
GET

### Endpoint
https://public.doubletick.io/chat-messages

### Parameters
#### Query Parameters
- **wabaNumber** (string) - Required - The WhatsApp Business Account Number in international format.
- **customerNumber** (string) - Required - The Customer's Phone Number in international format.
- **startDate** (string) - Optional - The start date for the chat messages in DD-MM-YYYY format.
- **endDate** (string) - Optional - The end date for the chat messages in DD-MM-YYYY format.

### Request Headers
- **Authorization** (string) - Required - YOUR_API_KEY
- **Content-Type** (string) - Required - application/json

### Response
#### Success Response (200)
- **messages** (array of objects) - Contains the details of the sent or received message.
  - **message** (object)
    - **text** (string) - The actual text message content.
    - **messageType** (string) - Type of message, e.g., "text".
  - **messageOriginType** (string) - Indicates the source of the message (e.g., "CUSTOMER", "USER", "SYSTEM").
  - **id** (string) - Unique identifier for the message.
  - **sentCount** (integer) - Number of times the message was sent.
  - **readCount** (integer) - Number of times the message was read.
  - **deliveryCount** (integer) - Number of times the message was successfully delivered.
  - **erroredCount** (integer) - Number of times the message failed to send.
  - **senderId** (string) - Unique identifier of the customer sending the message.
  - **templateId** (string) - ID of the template used (null if not a template message).
  - **repliesCount** (integer) - Number of replies received for this message.
  - **unreadCount** (integer) - Count of unread messages from the customer.
  - **noResponseCount** (integer) - Number of times the customer didn’t respond.
  - **isFromAd** (boolean) - Indicates if the message originated from an ad.
  - **messageMetadata** (object) - Contains additional metadata.
    - **status** (string)
  - **linkAnalytics** (object) - Data related to link tracking.
  - **senderUser** (object)
    - **id** (string) - User ID of the sender.
    - **name** (string) - Name of the sender.
    - **imageUrl** (string) - URL of the sender’s profile picture.
    - **phoneNumber** (string) - Sender’s phone number.
  - **integrationId** (string) - ID of the integration used to send the message.
  - **integrationDisplayName** (string) - Display name of the integration.
  - **messageTime** (integer) - Timestamp of when the message was sent (in milliseconds).
  - **quickActionButtonStats** (array) - Statistics for quick reply buttons.
  - **cardButtonStats** (array) - Statistics for card-based buttons.
  - **totalCount** (integer) - Total number of messages returned in this response.
  - **integrationWabaNumber** (string) - The registered WhatsApp Business Account (WABA) number used.

#### Response Example
```json
{
  "messages": [
    {
      "message": {
        "text": "text_message",
        "messageType": "text"
      },
      "messageOriginType": "CUSTOMER",
      "id": "message_id",
      "sentCount": 0,
      "readCount": 0,
      "deliveryCount": 0,
      "erroredCount": 0,
      "senderId": "customer_id",
      "templateId": null,
      "repliesCount": 0,
      "unreadCount": 0,
      "noResponseCount": 0,
      "isFromAd": false,
      "messageMetadata": {
        "status": null
      },
      "linkAnalytics": null,
      "senderUser": {
        "id": null,
        "name": null,
        "imageUrl": "",
        "phoneNumber": null
      },
      "integrationId": "integration_id",
      "integrationDisplayName": "DoubleTick Demo",
      "messageTime": 1737612046032,
      "quickActionButtonStats": [],
      "cardButtonStats": [],
      "totalCount": 1,
      "integrationWabaNumber": "integrated_waba_number"
    }
  ]
}
```

#### Error Responses
- **400 Bad Request**: Returned if the request parameters are invalid.
- **401 Unauthorized**: Returned if the API key is invalid.
- **404 Not Found**: Returned if the requested resource is not found.
```

--------------------------------

### Configure Template Import Endpoint

Source: https://docs.doubletick.io/docs/clevertap-integration

Set up the endpoint in CleverTap to fetch WhatsApp templates from DoubleTick. Ensure the WABA number in the URL matches your DoubleTick configuration.

```text
https://public.doubletick.io/templates/import?wabaNumber=919999999999
```

--------------------------------

### Request Body Parameters for Template Creation

Source: https://docs.doubletick.io/docs/create-new-template

Define the template's language, components (header, body, footer, buttons), category, name, and associated WhatsApp numbers.

```json
{
  "language": "en",
  "components": {
    "header": {
      "format": "TEXT",
      "text": "Header text"
    },
    "body": {
      "text": "Body Text"
    },
    "footer": {
      "text": "Footer Text"
    },
    "buttons": [
      {
        "type": "URL",
        "text": "Create New Template",
        "url": "https://your-file-url/file.jpg"
      }
    ]
  },
  "category": "UTILITY",
  "allowCategoryUpdate": true,
  "name": "your_template_name",
  "wabaNumbers": [
    "sender_number"
  ]
}
```

--------------------------------

### Bitrix24 REST API Settings for Local App

Source: https://docs.doubletick.io/docs/bitrix24-integration-with-doubletick

Navigate to the Developer Resources section within Bitrix24's REST API settings to create a local application. This is a prerequisite for integrating third-party applications like DoubleTick.

```text
Other (Create inbound and outbound webhooks or a local app)
Local Application
```

--------------------------------

### Get Team API Endpoint

Source: https://docs.doubletick.io/docs/get-team-1

Use this endpoint to retrieve all team members and their details.

```HTTP
GET https://public.doubletick.io/team
```

--------------------------------

### Success Response for Webhook Registration (201)

Source: https://docs.doubletick.io/docs/register-new-webhook

Confirms successful registration of webhooks, listing valid and invalid configurations.

```json
{
    "validWebhooks": [
        {
            "wabaNumber": "waba_number_assigned_to_webhook",
            "webhookEventType": "ADD_TAG"
        }
    ],
    "invalidWebhooks": [],
    "invalidWabaNumbers": []
}
```

--------------------------------

### Get Team Member Details

Source: https://docs.doubletick.io/docs/get-team-member-details-1

Retrieves detailed information about a specific team member using their unique agent number.

```APIDOC
## GET /team/member

### Description
Get detailed information about a specific team member including their role, reporting managers, and organization details.

### Method
GET

### Endpoint
https://public.doubletick.io/team/member

### Parameters
#### Request Body Parameters
- **agentNumber** (string, required): Phone Number of the team member/agent in international format.

### Request Example
```json
{
  "agentNumber": "team_member_number"
}
```

### Response
#### Success Response (200)
- **id** (string): Unique identifier for the agent.
- **name** (string): Name of the agent.
- **phone** (string): Agent’s phone number.
- **email** (string or null): Email address of the agent, null if not provided.
- **joinDate** (string): Date and time when the agent joined, in ISO format.
- **orgRoleId** (string): Unique identifier for the agent’s role in the organization.
- **orgRoleName** (string): Name of the agent’s role, such as "OWNER".
- **wabaRoles** (array): List of WhatsApp Business Accounts (WABA) associated with the agent.
  - **wabaName** (string): Name of the WhatsApp Business Account.
  - **wabaNumber** (string): WhatsApp API number linked to the account.
  - **roleName** (string): Role of the agent in the WABA, such as "OWNER".
- **isOrganizationOwner** (boolean): Indicates if the agent is the owner of the organization.
- **reportingManager** (array): List of reporting managers assigned to the agent.
  - **id** (string): Unique identifier for the reporting manager.
  - **name** (string): Name of the reporting manager.
  - **email** (string): Email address of the reporting manager.
  - **phone** (string): Phone number of the reporting manager.
  - **joinDate** (string): Date and time when the reporting manager joined, in ISO format.

#### Response Example
```json
{
  "id": "agnet_id",
  "name": "agent_name",
  "phone": "agent_number",
  "email": null,
  "joinDate": "2025-02-14T04:35:15.535Z",
  "orgRoleId": "organization_role_id",
  "orgRoleName": "OWNER",
  "wabaRoles": [
    {
      "wabaName": "WhatsApp Business Name",
      "wabaNumber": "WhatsApp API Number",
      "roleName": "OWNER"
    }
  ],
  "isOrganizationOwner": false,
  "reportingManager": [
    {
      "id": "reporting_manager_id",
      "name": "reporting_manager_name",
      "email": "reporting_manager_email",
      "phone": "reporting_manager_number",
      "joinDate": "2023-08-25T13:14:26.037Z"
    }
  ]
}
```

### Unauthorized (401)
```json
{
  "message": "Invalid public api key",
  "error": "Unauthorized",
  "statusCode": 401
}
```
```

--------------------------------

### Error Response JSON Examples

Source: https://docs.doubletick.io/docs/embed-chat-conversation

These JSON structures represent different error responses that may occur during API requests.

```json
{
  "message": "error_message",
  "error": "Bad Request",
  "statusCode": 400
}
```

```json
{
  "message": "Invalid public api key",
  "error": "Unauthorized",
  "statusCode": 401
}
```

```json
{
  "message": "No connected WhatsApp integration found",
  "error": "Not Found",
  "statusCode": 404
}
```

--------------------------------

### Not Found Response (404)

Source: https://docs.doubletick.io/docs/assign-team-member-to-customer-1

This response is returned when a requested resource is not found.

```JSON
{
  "message": "error_message",
  "code": "message_token"
}
```

--------------------------------

### Internal Server Error Response Example (500)

Source: https://docs.doubletick.io/docs/remove-custom-fields-andor-tags-from-customer

A 500 error indicates a problem on the server side that prevented the request from being fulfilled.

```JSON
{
  "statusCode": 500,
  "message": "Internal server error"
}
```

--------------------------------

### Request Body Parameters

Source: https://docs.doubletick.io/docs/check-reverted-on-time-1

Provide customer and agent details, along with the response time threshold, in the request body.

```json
{
  "phoneNumber": "customer_number",
  "waitingForResponseInSec": 1,
  "defaultAgentName": "agent_name",
  "defaultAgentNumber": "agent_waba_number",
  "wabaNumber": "your_waba_number"
}
```

--------------------------------

### Get Paginated Broadcast Groups

Source: https://docs.doubletick.io/docs/get-groups

Retrieves a paginated list of broadcast groups. You can filter, sort, and paginate the results using query parameters.

```APIDOC
## GET /groups

### Description
Retrieves a paginated list of broadcast groups. Supports filtering by search query, ordering by name or creation date, and pagination using group ID or creation date.

### Method
GET

### Endpoint
https://public.doubletick.io/groups

### Query Parameters
#### Query Parameters
- **searchQuery** (string) - Optional - The search query to filter groups by name.
- **orderBy** (string) - Optional - The field to order the groups by. Possible values: NAME, DATE_CREATED.
- **format** (string) - Optional - The order format to apply. Possible values: ASCENDING, DESCENDING.
- **afterGroupId** (string) - Optional - The group ID to fetch the groups after.
- **afterGroupName** (string) - Optional - The group name to fetch the groups after.
- **afterDateCreated** (date-time) - Optional - The group creation date to fetch the groups after. Format: YYYY-MM-DDTHH:MM:SS.

### Request Headers
- **Authorization** (string) - Required - YOUR_API_KEY
- **Content-Type** (string) - Required - application/json

### Response
#### Success Response (200)
- **groups** (array) - Contains broadcast group details.
  - **groupId** (string) - Unique identifier of the group.
  - **groupChatName** (string) - Name of the broadcast group.
  - **memberCount** (number) - Number of members in the group.
  - **dateCreated** (number) - Timestamp of when the group was created (in milliseconds).
  - **lastMessageAt** (string) - Date and time of the last message sent in the group (ISO format).
  - **groupType** (string) - Type of group, e.g., "STATIC_SEGMENT".
  - **isInternal** (boolean) - Indicates whether the group is internal.
- **paginationParams** (object) - Contains pagination details.
  - **hasMore** (boolean) - Indicates if more groups are available to fetch.

#### Response Example
```json
{
  "groups": [
    {
      "groupId": "group_id",
      "groupChatName": "broadcast_group_name",
      "memberCount": 5,
      "dateCreated": 1737568528728,
      "lastMessageAt": "2025-01-23T10:04:35.188Z",
      "groupType": "STATIC_SEGMENT",
      "isInternal": false
    }
  ],
  "paginationParams": {
    "hasMore": false
  }
}
```

#### Bad Request (400)
```json
{
  "message": "error_message",
  "error": "Bad Request",
  "statusCode": 400
}
```

#### Unauthorized (401)
```json
{
  "message": "Invalid public api key",
  "error": "Unauthorized",
  "statusCode": 401
}
```
```

--------------------------------

### API Endpoint for Creating Groups

Source: https://docs.doubletick.io/docs/create-group-1

Use this POST endpoint to initiate the creation of a new broadcast group.

```http
POST https://public.doubletick.io/groups
```

--------------------------------

### Success Response for Group Creation

Source: https://docs.doubletick.io/docs/create-group-1

This response is returned upon successful creation of a broadcast group, providing group details and any invalid members.

```json
{
  "groupData": {
    "groupId": "group_id",
    "memberCount": 2,
    "groupChatName": "broadcast_group_name"
  },
  "invalidMembers": [
    {
      "name": "customer_name",
      "phone": "customer_phone_number"
    }
  ]
}
```

--------------------------------

### API Endpoint for Chat Window Status

Source: https://docs.doubletick.io/docs/get-chat-window-status-1

Use this GET endpoint to retrieve the chat window status for a specific customer and WABA number.

```http
GET https://public.doubletick.io/chat/status
```
Tokens:
Raw