ClickSend REST API v3
  1. Voice
ClickSend REST API v3
  • Account
    • Get account
      GET
    • Create a new account
      POST
    • Update Account
      PUT
    • Send account activation token
      PUT
    • Verify new account
      PUT
    • Account Usage
      GET
  • Automation Rules
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
  • Contact Suggestions
    • List Contact Suggestions
  • Countries
    • Get all Countries
  • Delivery Issues
    • Get Delivery Issues
    • Create Delivery Issue
  • Email Marketing
    • Get All Email Campaigns
    • Calculate Price
    • Create Email Campaign
    • Get Specific Email Campaign History
    • Get Specific Email Campaign
    • Update Email Campaign
    • Cancel Email Campaign
    • Send Verification Token
    • Verify Allowed Email Address
    • Get All Allowed Email Addresses
    • Create Allowed Email Address
    • Delete Allowed Email Address
    • Get Specific Allowed Email Address
    • Get All Master Email Templates
    • Get All Master Template Categories
    • Get Specific Email Template Category
    • Get All Templates For Category
    • Get Specific Master Template
    • Get All Email Templates
    • Create New Email Template from Master Template
    • Upload Image to Specific Template
    • Delete Email Template
    • Get Specific Email Template
    • Update an Email Template
  • Transactional Email
    • Email History
    • Export History
    • Email Price
    • Add a Test Delivery Receipt
    • Email Send
  • Fax
    • Export Fax History
    • Get Fax History
    • Calculate Price
    • List of Fax Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Fax Delivery Receipts as read
    • Get a Specific Fax Delivery Receipt
    • Send Fax
  • Forgot Account
    • Forgot Password
    • Verify Forgot Password
    • Forgot Username
  • Contact Lists
    • Get all Contact Lists
    • Create a new contact list
    • Delete a specific contact list
    • Get a specific contact list
    • Update a specific contact list
    • Export Contacts List
    • Import Contacts to List
    • Show CSV Import File Preview
    • Get List of Acceptable Import Fields
    • Remove Duplicate Contacts
  • Contacts
    • Transfer a Contact
    • Get all Contacts in a List
    • Create a new contact
    • Delete a specific contact
    • Get a specific contact
    • Update a specific contact
    • Remove Opted Out Contacts
  • MMS
    • Cancel All MMS
    • Export MMS History
    • Get MMS History
    • Get Price
    • Get all Delivery Receipts
    • Mark Receipts As Read
    • Get Delivery Receipt
    • Send MMS
    • Cancel MMS
  • Numbers
    • Get all Dedicated Numbers
    • Buy dedicated number
    • Search Dedicated Numbers by Country
  • Post Direct Mail
    • List Direct Mail Campaigns
    • Calculate Direct Mail Campaign Price
    • Create New Campaign
    • Search Locations
  • Post Address Detection
    • Detect Address
  • Post Letter
    • Get Post Letter History
    • Export Post Letter History
    • Calculate Price
    • Send Post Letter
    • Get List of Post Return Addresses
    • Create a Post Return Address
    • Delete Post Return Address
    • Get Post Return Address
    • Update Post Return Address
  • Postcards
    • Export Postcard History
    • Get Postcard History
    • Calculate Pricing
    • Send Postcard
  • Pricing
    • Get Country Pricing
  • Account Recharge
    • Get Credit Card info
    • Update Credit Card info
    • List of Packages
    • Purchase a Package
    • Get Transactions
    • Get a specific transaction
  • Referral Accounts
    • Get List of Referral Accounts
  • Reseller
    • Get Reseller Setting
    • Update Reseller Setting
    • Reseller By Subdomain
  • Reseller Accounts
    • List of Reseller Accounts
    • Create Reseller Account
    • Create Reseller Account - Public
    • Get Reseller Account
    • Update Reseller Account
    • Transfer Credit
  • SDK
    • SDK Download
  • Search
    • Search Contacts-Lists
  • SMS Campaigns
    • Get list of SMS Campaigns
    • Calculate Price for SMS Campaign
    • Use Short URL
    • Link Tracking Export
    • Link Statistics
    • Link Tracking
    • Get SMS Campaign
    • Update an SMS Campaign
    • Cancel an SMS Campaign
  • SMS
    • Cancel all Scheduled Messages
    • Export SMS History
    • Get all History
    • Get all Inbound SMS - Pull
    • Add a Test Inbound SMS
    • Mark all Inbound SMS as read
    • Mark a specific Inbound SMS as read
    • Get Specific Inbound - Pull
    • Calculate Price
    • Get all Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Delivery Receipts as read
    • Get a Specific Delivery Receipt
    • Send an SMS
    • Cancel a Scheduled Message
  • Email-to-SMS Allowed Address
    • List of Email-to-SMS Allowed Address
    • Create Email to SMS Allowed Address
    • Delete Email-to-SMS Allowed Address
    • Get specific Email-to-SMS Allowed Address
    • Update Email-to-SMS Allowed Address
  • Email-to-SMS Stripped Strings
    • List Stripped Strings
    • Create Stripped String
    • Delete Stripped String
    • Find Specific Stripped String
    • Update Stripped String
  • SMS Templates
    • List of Templates
    • Create a Template
    • Delete a Template
    • Update a Template
  • Statistics
    • Get SMS Statistics
    • Get Voice Statistics
  • Subaccounts
    • Get all Subaccounts
    • Create a new subaccount
    • Delete a specific subaccount
    • Get a specific subaccount
    • Update a specific subaccount
    • Regenerate API Key
  • Timezones
    • Get Timezones
  • Uploads
    • Upload a file
  • Voice
    • Cancel all Voice Calls
      PUT
    • Export Voice History
      GET
    • Get Voice History
      GET
    • Voice Languages
      GET
    • Calculate Price
      POST
    • Get Voice receipts
      GET
    • Add a Test Delivery Receipt
      POST
    • Marked Voice Receipts as Read
      PUT
    • Get Specific Voice Receipt
      GET
    • Send a Voice Call
      POST
    • Cancel a Specific Voice Call
      PUT
  • Schemas
    • Schemas
      • Acceptable_Import_Fields
      • Account_Activation
      • Account_Collection
      • Allowed_From_Email_Addresses
      • Buy_dedicated_number
      • CSV_Import_File_Preview
      • Calculate_Price
      • Calculate_Price_for_SMS_Campaign
      • Calculate_Pricing
      • Cancel_Scheduled_Messages
      • Cancel_Voice_Calls
      • Contact
      • Contact_Collection
      • Contact_List
      • Contact_List_Collection
      • Contact_Suggestions
      • Country_Collection
      • Create_SMS_Campaign
      • Credit_Card_Info
      • Delivery_Issues
      • Delivery_Receipts
      • Detect_Address
      • Direct_Mail_Campaign
      • Email-to-SMS_Allowed_Address
      • Email-to-SMS_Allowed_Address_-_Object
      • Email_Campaigns
      • Email_Delivery_Receipt_Rules
      • Existing_SMS_Campaigns
      • Export_Contacts
      • Export_Post_Letter_History
      • Export_Postcard_History
      • Fax_Delivery_Receipt_Rules
      • Fax_History
      • Forgot_Password
      • Forgot_Username
      • Get_Country_Pricing
      • Get_Post_Letter_History
      • Get_Postcard_History
      • Get_SMS_Statistics
      • Get_Voice_Statistics
      • Get_all_Dedicated_Numbers
      • Import_Contacts
      • Inbound_Fax_Rules
      • Inbound_MMS
      • Inbound_SMS
      • Inbound_SMS_Rules
      • MMS_History
      • Master_Template_Categories
      • Master_Templates
      • Post_Code_Search
      • Post_Return_Address
      • Referral_Accounts
      • Remove_Duplicate_Contacts
      • Remove_Opted_Out_Contacts
      • Reseller
      • Reseller_Account
      • Reseller_Accounts
      • Reseller_Subdomain
      • SDK_Download
      • SMS_Delivery_Receipt_Rules
      • SMS_History
      • Search_Contacts-Lists
      • Search_Dedicated_Numbers_by_Country
      • Send_Fax
      • Send_Post_Letter
      • Send_Postcard
      • Send_a_Voice_Call_-_Text-to-speech
      • Send_an_MMS
      • Send_an_SMS
      • Stripped_Strings
      • Subaccount
      • Subaccount_Collection
      • Templates
      • Timezones
      • Transactional_Email
      • Transfer_Contact
      • URL_Shortening
      • Upload_Image
      • Upload_a_File
      • User_Email_Templates
      • Verify_Forgot_Password
      • Voice_Delivery_Receipt_Rules
      • Voice_History
      • Voice_Languages
    • RequestBodies
      • Add_a_Test_Delivery_ReceiptBody
      • Create_Email_CampaignBody
      • Create_Reseller_AccountBody
      • Create_a_Post_Return_AddressBody
      • Create_a_new_ruleBody
      • Create_a_new_ruleBody2
      • Send_FaxBody
  1. Voice

Add a Test Delivery Receipt

POST
/voice/receipts

Request

Body Params application/json

Examples

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://rest.clicksend.com/v3/voice/receipts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://yourdomain.com"
}'
Response Response Example
{
    "data": {
        "custom_string": null,
        "digits": "2",
        "error_code": null,
        "error_text": null,
        "message_id": "CEA5E06A-F4BF-4EC6-8315-B25087352DFA",
        "message_type": "voice",
        "status_code": "201",
        "status_text": "Success: Message received on handset.",
        "subaccount_id": 1746,
        "timestamp": "1489730505",
        "timestamp_send": "1489730505"
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Test receipt has been added."
}
Modified at 2023-08-15 06:42:18
Previous
Get Voice receipts
Next
Marked Voice Receipts as Read
Built with