| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.octopush.com/v1 | link | — | — | — |
Actions (47)
Contacts · 8
- Add contactsPOST /v1/public/contact/create
Add contacts to the account and attach to a contact list or tag.
documented - Create contact listPOST /v1/public/contact-list/create
Create a new contact list.
documented - Delete contact listDELETE /v1/public/contact-list/delete
Delete a contact list.
documented - Delete contactsDELETE /v1/public/contact/delete
Remove contacts or detach them from lists.
documented - Empty contact listPOST /v1/public/contact-list/empty
Empty a contact list (optionally delete all contacts).
documented - Get contact detailsGET /v1/public/contact/info
Retrieve information for a contact by phone number or email.
documented - Get contact listsGET /v1/public/contact-list
Retrieve the list of contact lists in the account.
documented - RCS compatibility checkPOST /v1/public/contact/rcs-compatibility
Check RCS compatibility for given numbers.
documented
SMS Campaigns · 7
- Cancel SMS campaignDELETE /v1/public/sms-campaign/cancel
Cancel a waiting or scheduled SMS campaign.
documented - Cancel SMS campaign on listDELETE /v1/public/sms-campaign-on-list/cancel
Cancel a queued or scheduled SMS campaign for a list/tag.
documented - Create SMS campaign on listPOST /v1/public/sms-campaign-on-list/create
Create an SMS campaign targeting a contact list or tag.
documented - Get status SMS campaign on listGET /v1/public/sms-campaign-on-list/status
Get the status of an SMS campaign sent to a list/tag.
documented - Retrieve draft SMS campaignGET /v1/public/sms-campaign/draft
Retrieve a draft SMS campaign if one exists.
documented - Send SMS campaignPOST /v1/public/sms-campaign/send
Send an SMS campaign to recipients (marketing/transactional).
documented - Send SMS campaign on listPOST /v1/public/sms-campaign-on-list/send
Confirm/launch an SMS campaign on a list/tag.
documented
API Subaccounts · 6
- Create subaccountPOST /v1/public/subaccount/create
Create a new sub-account.
documented - Delete subaccountDELETE /v1/public/subaccount/{email}/delete
Delete a sub-account.
documented - Edit subaccountPATCH /v1/public/subaccount/{email}/edit
Edit a sub-account's fields.
documented - Get a credit transfer tokenPOST /v1/public/subaccount/credit-transfer/token
Obtain a token for credit transfer.
documented - Get subaccountGET /v1/public/subaccount/{email}
Retrieve sub-account information.
documented - Transfer creditPOST /v1/public/subaccount/credit-transfer/transfer
Transfer credits between sub-accounts.
documented
Billing · 5
- Check SMS balanceGET /v1/public/wallet/check-balance
Check SMS balance (per service/pack).
documented - Check credits per serviceGET /v1/public/wallet/check-credits
Check credits per service per country (where supported).
documented - Edit automatic reload settingsPOST /v1/public/billing/settings/edit
Update automatic reload settings.
documented - Get automatic reload settingsGET /v1/public/billing/settings
Retrieve current automatic reload settings.
documented - Get monthly consumption dataPOST /v1/public/monthly-consumption
Retrieve monthly consumption data by channel/campaign.
documented
Conversation · 4
- Create multichannel conversationPOST /v1/public/conversation/create
Create a new multichannel conversation.
documented - List conversation messagesGET /v1/public/conversations/messages/list
Retrieve messages in a conversation.
documented - List conversationsGET /v1/public/conversations/list
Retrieve the conversations list.
documented - Set conversation agentPUT /v1/public/conversation/set-agent
Assign an agent to a conversation.
documented
Campaign Parameters · 3
- Edit default parameters (PATCH)PATCH /v1/public/campaign/parameters/edit
Edit default campaign parameters (PATCH).
documented - Edit default parameters (POST)POST /v1/public/campaign/parameters/edit
Edit default campaign parameters (POST).
documented - Retrieve general configurationGET /v1/public/campaign/parameters
Retrieve current default configuration for campaigns.
documented