> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# clicksend-voice

> ClickSend Voice & MMS

**Server path:** `/clicksend-voice` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                          | Description                                    |
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| [`clicksend_voice_cancel_all_put`](#clicksend_voice_cancel_all_put)                                                           | Update all voice messages as cancelled         |
| [`clicksend_voice_cancel_by_message_id_put`](#clicksend_voice_cancel_by_message_id_put)                                       | Update voice message status as cancelled       |
| [`clicksend_voice_delivery_receipt_automation_delete`](#clicksend_voice_delivery_receipt_automation_delete)                   | Delete voice delivery receipt automation       |
| [`clicksend_voice_delivery_receipt_automation_get`](#clicksend_voice_delivery_receipt_automation_get)                         | Get specific voice delivery receipt automation |
| [`clicksend_voice_delivery_receipt_automation_post`](#clicksend_voice_delivery_receipt_automation_post)                       | Create voice delivery receipt automations      |
| [`clicksend_voice_delivery_receipt_automation_put`](#clicksend_voice_delivery_receipt_automation_put)                         | Update voice delivery receipt automation       |
| [`clicksend_voice_delivery_receipt_automations_get`](#clicksend_voice_delivery_receipt_automations_get)                       | Get all voice delivery receipt automations     |
| [`clicksend_voice_history_export_get`](#clicksend_voice_history_export_get)                                                   | Export voice history                           |
| [`clicksend_voice_history_get`](#clicksend_voice_history_get)                                                                 | Get all voice history                          |
| [`clicksend_voice_lang_get`](#clicksend_voice_lang_get)                                                                       | Get all voice languages                        |
| [`clicksend_voice_mms_campaign_by_mms_campaign_id_get`](#clicksend_voice_mms_campaign_by_mms_campaign_id_get)                 | Get specific mms campaign                      |
| [`clicksend_voice_mms_campaigns_by_mms_campaign_id_put`](#clicksend_voice_mms_campaigns_by_mms_campaign_id_put)               | Update mms campaign                            |
| [`clicksend_voice_mms_campaigns_cancel_by_mms_campaign_id_put`](#clicksend_voice_mms_campaigns_cancel_by_mms_campaign_id_put) | Cancel mms campaign                            |
| [`clicksend_voice_mms_campaigns_get`](#clicksend_voice_mms_campaigns_get)                                                     | Get list of mms campaigns                      |
| [`clicksend_voice_mms_campaigns_price_post`](#clicksend_voice_mms_campaigns_price_post)                                       | Calculate price for mms campaign               |
| [`clicksend_voice_mms_campaigns_send_post`](#clicksend_voice_mms_campaigns_send_post)                                         | Create mms campaign                            |
| [`clicksend_voice_mms_history_export_get`](#clicksend_voice_mms_history_export_get)                                           | Export all mms history                         |
| [`clicksend_voice_mms_history_get`](#clicksend_voice_mms_history_get)                                                         | Get all mms history                            |
| [`clicksend_voice_mms_price_post`](#clicksend_voice_mms_price_post)                                                           | Get Price for MMS sent                         |
| [`clicksend_voice_mms_receipts_get`](#clicksend_voice_mms_receipts_get)                                                       | Get all delivery receipts                      |
| [`clicksend_voice_mms_receipts_read_put`](#clicksend_voice_mms_receipts_read_put)                                             | Mark delivery receipts as read                 |
| [`clicksend_voice_mms_send_post`](#clicksend_voice_mms_send_post)                                                             | Send MMS                                       |
| [`clicksend_voice_price_post`](#clicksend_voice_price_post)                                                                   | Calculate voice price                          |
| [`clicksend_voice_receipts_get`](#clicksend_voice_receipts_get)                                                               | Get all delivery receipts                      |
| [`clicksend_voice_receipts_post`](#clicksend_voice_receipts_post)                                                             | Add a delivery receipt                         |
| [`clicksend_voice_receipts_read_put`](#clicksend_voice_receipts_read_put)                                                     | Mark delivery receipts as read                 |
| [`clicksend_voice_send_post`](#clicksend_voice_send_post)                                                                     | Send voice message(s)                          |

***

## clicksend\_voice\_cancel\_all\_put

Update all voice messages as cancelled

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_cancel\_by\_message\_id\_put

Update voice message status as cancelled

**Parameters:**

| Parameter    | Type   | Required | Default | Description           |
| ------------ | ------ | -------- | ------- | --------------------- |
| `message_id` | string | Yes      | —       | Your voice message id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "message_id": {
        "type": "string",
        "description": "Your voice message id"
      }
    },
    "required": [
      "PCID",
      "message_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_delivery\_receipt\_automation\_delete

Delete voice delivery receipt automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description     |
| ----------------- | ------- | -------- | ------- | --------------- |
| `receipt_rule_id` | integer | Yes      | —       | Receipt rule id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "receipt_rule_id": {
        "type": "integer",
        "description": "Receipt rule id"
      }
    },
    "required": [
      "PCID",
      "receipt_rule_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_delivery\_receipt\_automation\_get

Get specific voice delivery receipt automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description     |
| ----------------- | ------- | -------- | ------- | --------------- |
| `receipt_rule_id` | integer | Yes      | —       | Receipt rule id |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "receipt_rule_id": {
        "type": "integer",
        "description": "Receipt rule id"
      }
    },
    "required": [
      "PCID",
      "receipt_rule_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_delivery\_receipt\_automation\_post

Create voice delivery receipt automations

**Parameters:**

| Parameter        | Type   | Required | Default | Description                                                                                                                                                                                                                        |
| ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `action`         | string | Yes      | —       | Action to be taken (AUTO\_REPLY, EMAIL\_USER, EMAIL\_FIXED, URL, SMS, POLL, GROUP\_SMS, MOVE\_CONTACT, CREATE\_CONTACT, CREATE\_CONTACT\_PLUS\_EMAIL, CREATE\_CONTACT\_PLUS\_NAME\_EMAIL CREATE\_CONTACT\_PLUS\_NAME, SMPP, NONE). |
| `action_address` | string | Yes      | —       | Action address.                                                                                                                                                                                                                    |
| `enabled`        | number | Yes      | —       | Enabled: Disabled=0 or Enabled=1.                                                                                                                                                                                                  |
| `match_type`     | number | Yes      | —       | Match Type. 0=All reports.                                                                                                                                                                                                         |
| `rule_name`      | string | Yes      | —       | Rule Name.                                                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "action": {
        "type": "string",
        "description": "Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE)."
      },
      "action_address": {
        "type": "string",
        "description": "Action address."
      },
      "enabled": {
        "type": "number",
        "description": "Enabled: Disabled=0 or Enabled=1."
      },
      "match_type": {
        "type": "number",
        "description": "Match Type. 0=All reports."
      },
      "rule_name": {
        "type": "string",
        "description": "Rule Name."
      }
    },
    "required": [
      "PCID",
      "action",
      "action_address",
      "enabled",
      "match_type",
      "rule_name"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_delivery\_receipt\_automation\_put

Update voice delivery receipt automation

**Parameters:**

| Parameter         | Type    | Required | Default | Description                                                                                                                                                                                                                        |
| ----------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `receipt_rule_id` | integer | Yes      | —       | Receipt rule id                                                                                                                                                                                                                    |
| `action`          | string  | Yes      | —       | Action to be taken (AUTO\_REPLY, EMAIL\_USER, EMAIL\_FIXED, URL, SMS, POLL, GROUP\_SMS, MOVE\_CONTACT, CREATE\_CONTACT, CREATE\_CONTACT\_PLUS\_EMAIL, CREATE\_CONTACT\_PLUS\_NAME\_EMAIL CREATE\_CONTACT\_PLUS\_NAME, SMPP, NONE). |
| `action_address`  | string  | Yes      | —       | Action address.                                                                                                                                                                                                                    |
| `enabled`         | number  | Yes      | —       | Enabled: Disabled=0 or Enabled=1.                                                                                                                                                                                                  |
| `match_type`      | number  | Yes      | —       | Match Type. 0=All reports.                                                                                                                                                                                                         |
| `rule_name`       | string  | Yes      | —       | Rule Name.                                                                                                                                                                                                                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "receipt_rule_id": {
        "type": "integer",
        "description": "Receipt rule id"
      },
      "action": {
        "type": "string",
        "description": "Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE)."
      },
      "action_address": {
        "type": "string",
        "description": "Action address."
      },
      "enabled": {
        "type": "number",
        "description": "Enabled: Disabled=0 or Enabled=1."
      },
      "match_type": {
        "type": "number",
        "description": "Match Type. 0=All reports."
      },
      "rule_name": {
        "type": "string",
        "description": "Rule Name."
      }
    },
    "required": [
      "PCID",
      "receipt_rule_id",
      "action",
      "action_address",
      "enabled",
      "match_type",
      "rule_name"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_delivery\_receipt\_automations\_get

Get all voice delivery receipt automations

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `q`       | string  | No       | —       | Your keyword or query.     |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "q": {
        "type": "string",
        "description": "Your keyword or query."
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_history\_export\_get

Export voice history

**Parameters:**

| Parameter  | Type   | Required | Default | Description           |
| ---------- | ------ | -------- | ------- | --------------------- |
| `filename` | string | Yes      | —       | Filename to export to |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "filename": {
        "type": "string",
        "description": "Filename to export to"
      }
    },
    "required": [
      "PCID",
      "filename"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_history\_get

Get all voice history

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                    |
| ----------- | ------- | -------- | ------- | ---------------------------------------------- |
| `date_from` | integer | No       | —       | Timestamp (from) used to show records by date. |
| `date_to`   | integer | No       | —       | Timestamp (to) used to show records by date    |
| `page`      | integer | No       | —       | Page number                                    |
| `limit`     | integer | No       | —       | Number of records per page                     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "date_from": {
        "type": "integer",
        "description": "Timestamp (from) used to show records by date."
      },
      "date_to": {
        "type": "integer",
        "description": "Timestamp (to) used to show records by date"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_lang\_get

Get all voice languages

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_campaign\_by\_mms\_campaign\_id\_get

Get specific mms campaign

**Parameters:**

| Parameter         | Type    | Required | Default | Description                    |
| ----------------- | ------- | -------- | ------- | ------------------------------ |
| `mms_campaign_id` | integer | Yes      | —       | ID of MMS campaign to retrieve |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "mms_campaign_id": {
        "type": "integer",
        "description": "ID of MMS campaign to retrieve"
      }
    },
    "required": [
      "PCID",
      "mms_campaign_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_campaigns\_by\_mms\_campaign\_id\_put

Update mms campaign

**Parameters:**

| Parameter         | Type    | Required | Default | Description                                                                                                                                                           |
| ----------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mms_campaign_id` | integer | Yes      | —       | ID of MMS campaign to update                                                                                                                                          |
| `body`            | string  | Yes      | —       | Your campaign message.                                                                                                                                                |
| `from`            | string  | No       | —       | Your sender id - more info: [https://help.clicksend.com/en/collections/57584-numbers-sender-ids](https://help.clicksend.com/en/collections/57584-numbers-sender-ids). |
| `list_id`         | integer | Yes      | —       | Your list id.                                                                                                                                                         |
| `media_file`      | string  | Yes      | —       | URL pointing to media file.                                                                                                                                           |
| `name`            | string  | Yes      | —       | Your campaign name.                                                                                                                                                   |
| `schedule`        | integer | No       | —       | Your schedule timestamp.                                                                                                                                              |
| `subject`         | string  | Yes      | —       | Subject of MMS campaign.                                                                                                                                              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "mms_campaign_id": {
        "type": "integer",
        "description": "ID of MMS campaign to update"
      },
      "body": {
        "type": "string",
        "description": "Your campaign message."
      },
      "from": {
        "type": "string",
        "description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
      },
      "list_id": {
        "type": "integer",
        "description": "Your list id."
      },
      "media_file": {
        "type": "string",
        "description": "URL pointing to media file."
      },
      "name": {
        "type": "string",
        "description": "Your campaign name."
      },
      "schedule": {
        "type": "integer",
        "description": "Your schedule timestamp."
      },
      "subject": {
        "type": "string",
        "description": "Subject of MMS campaign."
      }
    },
    "required": [
      "PCID",
      "mms_campaign_id",
      "body",
      "list_id",
      "media_file",
      "name",
      "subject"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_campaigns\_cancel\_by\_mms\_campaign\_id\_put

Cancel mms campaign

**Parameters:**

| Parameter         | Type    | Required | Default | Description                  |
| ----------------- | ------- | -------- | ------- | ---------------------------- |
| `mms_campaign_id` | integer | Yes      | —       | ID of MMS Campaign to cancel |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "mms_campaign_id": {
        "type": "integer",
        "description": "ID of MMS Campaign to cancel"
      }
    },
    "required": [
      "PCID",
      "mms_campaign_id"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_campaigns\_get

Get list of mms campaigns

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_campaigns\_price\_post

Calculate price for mms campaign

**Parameters:**

| Parameter    | Type    | Required | Default | Description                                                                                                                                                           |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `body`       | string  | Yes      | —       | Your campaign message.                                                                                                                                                |
| `from`       | string  | No       | —       | Your sender id - more info: [https://help.clicksend.com/en/collections/57584-numbers-sender-ids](https://help.clicksend.com/en/collections/57584-numbers-sender-ids). |
| `list_id`    | integer | Yes      | —       | Your list id.                                                                                                                                                         |
| `media_file` | string  | Yes      | —       | URL pointing to media file.                                                                                                                                           |
| `name`       | string  | Yes      | —       | Your campaign name.                                                                                                                                                   |
| `schedule`   | integer | No       | —       | Your schedule timestamp.                                                                                                                                              |
| `subject`    | string  | Yes      | —       | Subject of MMS campaign.                                                                                                                                              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "body": {
        "type": "string",
        "description": "Your campaign message."
      },
      "from": {
        "type": "string",
        "description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
      },
      "list_id": {
        "type": "integer",
        "description": "Your list id."
      },
      "media_file": {
        "type": "string",
        "description": "URL pointing to media file."
      },
      "name": {
        "type": "string",
        "description": "Your campaign name."
      },
      "schedule": {
        "type": "integer",
        "description": "Your schedule timestamp."
      },
      "subject": {
        "type": "string",
        "description": "Subject of MMS campaign."
      }
    },
    "required": [
      "PCID",
      "body",
      "list_id",
      "media_file",
      "name",
      "subject"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_campaigns\_send\_post

Create mms campaign

**Parameters:**

| Parameter    | Type    | Required | Default | Description                                                                                                                                                           |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `body`       | string  | Yes      | —       | Your campaign message.                                                                                                                                                |
| `from`       | string  | No       | —       | Your sender id - more info: [https://help.clicksend.com/en/collections/57584-numbers-sender-ids](https://help.clicksend.com/en/collections/57584-numbers-sender-ids). |
| `list_id`    | integer | Yes      | —       | Your list id.                                                                                                                                                         |
| `media_file` | string  | Yes      | —       | URL pointing to media file.                                                                                                                                           |
| `name`       | string  | Yes      | —       | Your campaign name.                                                                                                                                                   |
| `schedule`   | integer | No       | —       | Your schedule timestamp.                                                                                                                                              |
| `subject`    | string  | Yes      | —       | Subject of MMS campaign.                                                                                                                                              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "body": {
        "type": "string",
        "description": "Your campaign message."
      },
      "from": {
        "type": "string",
        "description": "Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids."
      },
      "list_id": {
        "type": "integer",
        "description": "Your list id."
      },
      "media_file": {
        "type": "string",
        "description": "URL pointing to media file."
      },
      "name": {
        "type": "string",
        "description": "Your campaign name."
      },
      "schedule": {
        "type": "integer",
        "description": "Your schedule timestamp."
      },
      "subject": {
        "type": "string",
        "description": "Subject of MMS campaign."
      }
    },
    "required": [
      "PCID",
      "body",
      "list_id",
      "media_file",
      "name",
      "subject"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_history\_export\_get

Export all mms history

**Parameters:**

| Parameter  | Type   | Required | Default | Description                     |
| ---------- | ------ | -------- | ------- | ------------------------------- |
| `filename` | string | Yes      | —       | Filename to download history as |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "filename": {
        "type": "string",
        "description": "Filename to download history as"
      }
    },
    "required": [
      "PCID",
      "filename"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_history\_get

Get all mms history

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                            |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------ |
| `q`         | string  | No       | —       | Custom query Example: from:\{number},status\_code:201. |
| `date_from` | integer | No       | —       | Start date                                             |
| `date_to`   | integer | No       | —       | End date                                               |
| `page`      | integer | No       | —       | Page number                                            |
| `limit`     | integer | No       | —       | Number of records per page                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "q": {
        "type": "string",
        "description": "Custom query Example: from:{number},status_code:201."
      },
      "date_from": {
        "type": "integer",
        "description": "Start date"
      },
      "date_to": {
        "type": "integer",
        "description": "End date"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_price\_post

Get Price for MMS sent

**Parameters:**

| Parameter    | Type      | Required | Default | Description                 |
| ------------ | --------- | -------- | ------- | --------------------------- |
| `media_file` | string    | Yes      | —       | Media file you want to send |
| `messages`   | object\[] | Yes      | —       | Array of MmsMessage models  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "media_file": {
        "type": "string",
        "description": "Media file you want to send"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "to": {
              "type": "string",
              "description": "Recipient phone number in E.164 format"
            },
            "body": {
              "type": "string",
              "description": "Your message"
            },
            "subject": {
              "type": "string",
              "description": "Subject line (max 20 characters)"
            },
            "from": {
              "type": "string",
              "description": "Your sender ID"
            },
            "country": {
              "type": "string",
              "description": "Recipient country"
            },
            "source": {
              "type": "string",
              "description": "Your method of sending"
            },
            "list_id": {
              "type": "integer",
              "format": "int32",
              "description": "Your list ID if sending to a whole list (can be used instead of 'to')"
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "Schedule time in unix format (leave blank for immediate delivery)"
            },
            "custom_string": {
              "type": "string",
              "description": "Custom string for your reference"
            },
            "from_email": {
              "type": "string",
              "description": "Email to send replies to"
            }
          },
          "required": [
            "body",
            "subject"
          ]
        },
        "description": "Array of MmsMessage models"
      }
    },
    "required": [
      "PCID",
      "media_file",
      "messages"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_receipts\_get

Get all delivery receipts

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_receipts\_read\_put

Mark delivery receipts as read

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                                                                        |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `date_before` | number | No       | —       | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "date_before": {
        "type": "number",
        "description": "An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_mms\_send\_post

Send MMS

**Parameters:**

| Parameter    | Type      | Required | Default | Description                 |
| ------------ | --------- | -------- | ------- | --------------------------- |
| `media_file` | string    | Yes      | —       | Media file you want to send |
| `messages`   | object\[] | Yes      | —       | Array of MmsMessage models  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "media_file": {
        "type": "string",
        "description": "Media file you want to send"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "to": {
              "type": "string",
              "description": "Recipient phone number in E.164 format"
            },
            "body": {
              "type": "string",
              "description": "Your message"
            },
            "subject": {
              "type": "string",
              "description": "Subject line (max 20 characters)"
            },
            "from": {
              "type": "string",
              "description": "Your sender ID"
            },
            "country": {
              "type": "string",
              "description": "Recipient country"
            },
            "source": {
              "type": "string",
              "description": "Your method of sending"
            },
            "list_id": {
              "type": "integer",
              "format": "int32",
              "description": "Your list ID if sending to a whole list (can be used instead of 'to')"
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "Schedule time in unix format (leave blank for immediate delivery)"
            },
            "custom_string": {
              "type": "string",
              "description": "Custom string for your reference"
            },
            "from_email": {
              "type": "string",
              "description": "Email to send replies to"
            }
          },
          "required": [
            "body",
            "subject"
          ]
        },
        "description": "Array of MmsMessage models"
      }
    },
    "required": [
      "PCID",
      "media_file",
      "messages"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_price\_post

Calculate voice price

**Parameters:**

| Parameter  | Type      | Required | Default | Description                 |
| ---------- | --------- | -------- | ------- | --------------------------- |
| `messages` | object\[] | Yes      | —       | Array of VoiceMessage items |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "to": {
              "type": "string",
              "description": "Your phone number in E.164 format."
            },
            "body": {
              "type": "string",
              "description": "Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin."
            },
            "voice": {
              "type": "string",
              "description": "Either 'female' or 'male'."
            },
            "custom_string": {
              "type": "string",
              "description": "Your reference. Will be passed back with all replies and delivery reports."
            },
            "country": {
              "type": "string",
              "description": "The country of the recipient."
            },
            "source": {
              "type": "string",
              "description": "Your method of sending e.g. 'wordpress', 'php', 'c#'."
            },
            "list_id": {
              "type": "integer",
              "format": "int32",
              "description": "Your list ID if sending to a whole list. Can be used instead of 'to'."
            },
            "lang": {
              "type": "string",
              "description": "au (string, required) - See section on available languages."
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp"
            },
            "require_input": {
              "type": "integer",
              "format": "int32",
              "description": "Whether you want to receive a keypress from the call recipient"
            },
            "machine_detection": {
              "type": "integer",
              "format": "int32",
              "description": "Whether to attempt to detect an answering machine or voicemail service and leave a message"
            }
          },
          "required": [
            "body",
            "country",
            "custom_string",
            "voice"
          ]
        },
        "description": "Array of VoiceMessage items"
      }
    },
    "required": [
      "PCID",
      "messages"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_receipts\_get

Get all delivery receipts

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `page`    | integer | No       | —       | Page number                |
| `limit`   | integer | No       | —       | Number of records per page |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "limit": {
        "type": "integer",
        "description": "Number of records per page"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_receipts\_post

Add a delivery receipt

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `url`     | string | Yes      | —       | Your url.   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "url": {
        "type": "string",
        "description": "Your url."
      }
    },
    "required": [
      "PCID",
      "url"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_receipts\_read\_put

Mark delivery receipts as read

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                                                                                        |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `date_before` | number | No       | —       | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "date_before": {
        "type": "number",
        "description": "An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## clicksend\_voice\_send\_post

Send voice message(s)

**Parameters:**

| Parameter  | Type      | Required | Default | Description                 |
| ---------- | --------- | -------- | ------- | --------------------------- |
| `messages` | object\[] | Yes      | —       | Array of VoiceMessage items |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "messages": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "to": {
              "type": "string",
              "description": "Your phone number in E.164 format."
            },
            "body": {
              "type": "string",
              "description": "Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin."
            },
            "voice": {
              "type": "string",
              "description": "Either 'female' or 'male'."
            },
            "custom_string": {
              "type": "string",
              "description": "Your reference. Will be passed back with all replies and delivery reports."
            },
            "country": {
              "type": "string",
              "description": "The country of the recipient."
            },
            "source": {
              "type": "string",
              "description": "Your method of sending e.g. 'wordpress', 'php', 'c#'."
            },
            "list_id": {
              "type": "integer",
              "format": "int32",
              "description": "Your list ID if sending to a whole list. Can be used instead of 'to'."
            },
            "lang": {
              "type": "string",
              "description": "au (string, required) - See section on available languages."
            },
            "schedule": {
              "type": "integer",
              "format": "int32",
              "description": "Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp"
            },
            "require_input": {
              "type": "integer",
              "format": "int32",
              "description": "Whether you want to receive a keypress from the call recipient"
            },
            "machine_detection": {
              "type": "integer",
              "format": "int32",
              "description": "Whether to attempt to detect an answering machine or voicemail service and leave a message"
            }
          },
          "required": [
            "body",
            "country",
            "custom_string",
            "voice"
          ]
        },
        "description": "Array of VoiceMessage items"
      }
    },
    "required": [
      "PCID",
      "messages"
    ]
  }
  ```
</Expandable>