> For the complete documentation index, see [llms.txt](https://www.docpartner.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.docpartner.dev/en/api.md). # API - [SMS Partner](https://www.docpartner.dev/en/api/sms-partner.md): Introduction to the SMS Partner API - [Webhooks](https://www.docpartner.dev/en/api/sms-partner/webhooks.md): Manage the statuses and replies of your SMS campaigns - [Credits](https://www.docpartner.dev/en/api/sms-partner/credits.md): This request is used to retrieve your available SMS credits, as well as the number of pending outgoing SMS. - [Sub-accounts](https://www.docpartner.dev/en/api/sms-partner/sub-accounts.md): Manage your sub-accounts. - [Activation](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/activation.md): Learn how to activate the sub-account creation feature. - [Create Sub-account](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/create-sub-account.md): This request is used to create a sub-account. - [Delete Sub-account](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/delete-sub-account.md): This request is used to delete a sub-account. - [Sub-account List](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/sub-account-list.md): This request is used to list the sub-accounts of your main account. - [Manage Sub-account Credits](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/manage-sub-account-credits.md): This request is used to manage sub-account credits. - [Rate limiting](https://www.docpartner.dev/en/api/sms-partner/rate-limiting.md) - [Send SMS](https://www.docpartner.dev/en/api/sms-partner/send-sms.md): Les différentes méthode d'envoi de SMS - [Character counter](https://www.docpartner.dev/en/api/sms-partner/send-sms/character-counter.md): Estimate an SMS before sending: number of segments, detected encoding, unit price and total cost, based on your account's rate. - [Single Send](https://www.docpartner.dev/en/api/sms-partner/send-sms/single-send.md): This request is used to send SMS in real-time or scheduled. - [Bulk Send](https://www.docpartner.dev/en/api/sms-partner/send-sms/bulk-send.md): This request is used to send SMS messages in real-time or scheduled. - [Send by Long Number](https://www.docpartner.dev/en/api/sms-partner/send-sms/send-by-long-number.md): This request is used to send SMS using a long number. A long number looks like: +337XXXXXXXX - [Survey Send](https://www.docpartner.dev/en/api/sms-partner/send-sms/survey-send.md): This request is used to send a survey in real-time or scheduled. - [Cancel Scheduled SMS](https://www.docpartner.dev/en/api/sms-partner/send-sms/cancel-scheduled-sms.md): This request is used to cancel a scheduled SMS. - [Special Characters](https://www.docpartner.dev/en/api/sms-partner/send-sms/special-characters.md): List of special characters replaced when sending an SMS. - [Status & Statistics](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics.md): Different SMS sending methods - [Single Status](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/single-status.md): This request allows you to retrieve the status of a single SMS. - [Bulk Status](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/bulk-status.md): This request allows you to retrieve the status of multiple SMS (up to 500 numbers). - [Status by Message](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/status-by-message.md): This request allows you to retrieve the statuses of multiple SMS using a message ID. - [Status by Tag](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/status-by-tag.md): This request allows you to retrieve the statuses of multiple SMS using a tag. - [Sending Statistics](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/sending-statistics.md): This request is used to retrieve sending statistics over a specific period. It returns the number of SMS sent and the associated cost. - [Contact Management](https://www.docpartner.dev/en/api/sms-partner/contact-management.md): Manage your contact groups and contacts - [Add Group](https://www.docpartner.dev/en/api/sms-partner/contact-management/add-group.md): This request is used to create a new contact group - [Add Contact](https://www.docpartner.dev/en/api/sms-partner/contact-management/add-contact.md): This request is used to create a contact within a group - [Delete Group](https://www.docpartner.dev/en/api/sms-partner/contact-management/delete-group.md): This request is used to delete a group - [Add Bulk Contacts](https://www.docpartner.dev/en/api/sms-partner/contact-management/add-bulk-contacts.md): This request is used to add a batch of up to 500 contacts. - [Edit Contact](https://www.docpartner.dev/en/api/sms-partner/contact-management/edit-contact.md): This request is used to update an existing contact. - [Delete Contact](https://www.docpartner.dev/en/api/sms-partner/contact-management/delete-contact.md): This request is used to delete a contact - [Get Group List](https://www.docpartner.dev/en/api/sms-partner/contact-management/get-group-list.md): This request is used to retrieve the list of contact groups - [Get Contact List](https://www.docpartner.dev/en/api/sms-partner/contact-management/get-contact-list.md): This request is used to retrieve the list of contacts in a group - [Get Contact Details](https://www.docpartner.dev/en/api/sms-partner/contact-management/get-contact-details.md): This request is used to retrieve the details of a contact - [Replies / Opt-outs Management](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management.md): Manage your replies and SMS opt-outs - [Stop List](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management/stop-list.md): This request is used to retrieve the list of SMS opt-outs - [Add Number to SMS Stop List](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management/add-number-to-sms-stop-list.md): This request is used to add a number to the SMS stop list - [Remove Number from SMS Stop List](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management/remove-number-from-sms-stop-list.md): This request is used to remove a number from the SMS stop list. - [RCS](https://www.docpartner.dev/en/api/sms-partner/rcs.md) - [RCS Scenario](https://www.docpartner.dev/en/api/sms-partner/rcs/rcs-scenario.md): This request starts an RCS scenario for a list of numbers from its identifier (token). - [Number Verification](https://www.docpartner.dev/en/api/sms-partner/number-verification.md): Manage your replies and SMS opt-outs - [Send a Verification](https://www.docpartner.dev/en/api/sms-partner/number-verification/send-a-verification.md): This request is used to send an HLR verification. - [Format Verification](https://www.docpartner.dev/en/api/sms-partner/number-verification/format-verification.md): This request is used to check the format of a mobile number. It is available for free. - [Contact Rental](https://www.docpartner.dev/en/api/sms-partner/contact-rental.md): Rent a database of phone numbers for your SMS campaign! - [Categories](https://www.docpartner.dev/en/api/sms-partner/contact-rental/categories.md): List of categories and subcategories. - [Targeting & Calculation](https://www.docpartner.dev/en/api/sms-partner/contact-rental/targeting-and-calculation.md): This request allows you to calculate targeting and its cost. - [Rental Status](https://www.docpartner.dev/en/api/sms-partner/contact-rental/rental-status.md): This request allows you to retrieve the status of a contact rental. - [Download File](https://www.docpartner.dev/en/api/sms-partner/contact-rental/download-file.md): This request allows you to download the file of the location - [Voice Partner](https://www.docpartner.dev/en/api/voice-partner.md): Introduction to the Voice Partner API - [Webhooks](https://www.docpartner.dev/en/api/voice-partner/statuses.md): Receive the statuses of your voice campaigns - [Credits](https://www.docpartner.dev/en/api/voice-partner/credits.md): This request is used to retrieve your available voice message and voicemail drop credit. - [Sub-accounts](https://www.docpartner.dev/en/api/voice-partner/sub-accounts.md): Manage your sub-accounts. - [Activation](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/activation.md): Learn how to activate the sub-account creation feature. - [Create Sub-account](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/create-sub-account.md): This request is used to create a sub-account. - [Delete Sub-account](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/delete-sub-account.md): This request is used to delete a sub-account. - [Sub-account List](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/sub-account-list.md): This request is used to list the sub-accounts of your main account. - [Manage Sub-account Credits](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/manage-sub-account-credits.md): This request is used to create a sub-account. - [Voice Message](https://www.docpartner.dev/en/api/voice-partner/voice-message.md): Manage your voice messages - [Audio File List](https://www.docpartner.dev/en/api/voice-partner/voice-message/audio-file-list.md): Retrieve the list of audio files added and validated - [Rename an Audio File](https://www.docpartner.dev/en/api/voice-partner/voice-message/rename-audio-file.md): Rename an already existing audio file - [Upload a Voice Message](https://www.docpartner.dev/en/api/voice-partner/voice-message/upload-a-voice-message.md): Uploading a voice message (VMS) is available via the API. Uploading works for both landlines and mobiles. It is important to note that the behavior is different. - [Send a Voice SMS](https://www.docpartner.dev/en/api/voice-partner/send-a-voice-sms.md): This request is used to send a Voice SMS to a mobile phone - [Cancel a Scheduled Send](https://www.docpartner.dev/en/api/voice-partner/cancel-scheduled-send.md): This request is used to cancel the scheduled sending of a voice message or voice SMS - [Mail Partner](https://www.docpartner.dev/en/api/mail-partner.md): Introduction to the Mail Partner API - [Webhooks](https://www.docpartner.dev/en/api/mail-partner/webhooks.md): Manage the statuses of your email campaigns - [Credits](https://www.docpartner.dev/en/api/mail-partner/credits.md): This request is used to retrieve your available email credit. - [Sub-accounts](https://www.docpartner.dev/en/api/mail-partner/sub-accounts.md): Manage your sub-accounts - [Activation](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/activation.md): Learn how to activate the sub-account creation feature. - [Create Sub-account](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/create-sub-account.md): This request is used to create a sub-account. - [Sub-account List](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/sub-account-list.md): This request is used to list the sub-accounts of your main account. - [Manage Sub-account Credits](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/manage-sub-account-credits.md): These requests are used to add or remove credits from a sub-account. - [Rate limiting](https://www.docpartner.dev/en/api/mail-partner/rate-limiting.md) - [Single Email Send](https://www.docpartner.dev/en/api/mail-partner/single-send.md): This request is used to send emails in real time or scheduled. - [Cancel an Email Send](https://www.docpartner.dev/en/api/mail-partner/cancel-email-send.md): This request is used to cancel a scheduled email send. - [Status by Message](https://www.docpartner.dev/en/api/mail-partner/status-by-message.md): This request is used to retrieve the status of each recipient of a message. - [Unsubscribe Management](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management.md): Manage your email unsubscriptions - [Add an Email](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management/add-email.md): This request lets you add an email to the unsubscribe list. - [Unsubscribe List](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management/unsubscribe-list.md): This request is used to retrieve the list of unsubscribed emails. - [Delete an Email](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management/delete-email.md): This request lets you remove an email from the unsubscribe list. - [Error Codes](https://www.docpartner.dev/en/api/error-codes.md): List of all error codes --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://www.docpartner.dev/en/api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.