Index of URLs

The root URL of the Octopush SMS API is:

URL
https://api.octopush.com/v1/public

ServiceType and URL

Text SMS sending

SMS sending
POST
/sms-campaign/send
Scheduled SMS sending
POST
/sms-campaign/send

Sending text SMS to a list

Sending SMS to a list
POST
/sms-campaign-on-list/create
Status SMS on a list
GET
/sms-campaign-on-list/status
Confirm SMS on a list
POST
/sms-campaign-on-list/send
Cancel SMS on a list
DELETE
/sms-campaign-on-list/cancel

Voice SMS sending

Sending Voice SMS
POST
/vocal-campaign/send
Scheduled voice SMS sending
POST
/vocal-campaign/send

Sending voice SMS to a list

Sending Voice SMS to list
POST
/vocal-campaign-on-list/create
Voice SMS status on list
GET
/vocal-campaign-on-list/status
Confirm a Voice SMS on list
POST
/vocal-campaign-on-list/send
Cancel Voice SMS on the list
DELETE
/vocal-campaign-on-list/cancel

Contact management

Add a contact
POST
/contact/create
Delete a contact
DELETE
/contact/delete
Clear a list
POST
/contact-list/empty
Delete a list
DELETE
/contact-list/delete
HRL Lookup – Number Check
POST
/contact/hlr-request

SMS credit balance

Check SMS Balance
GET
/wallet/check-balance
SMS balance by country
GET
/wallet/check-balance
Check your credit (in euros)
GET
/wallet/check-credits
Credit by service
GET
/wallet/check-credits

Sub-accounts Management

Create a sub-account
POST
/subaccount/create
Modify a sub-account
PATCH
/subaccount/{*****@sub-accounts.com}/edit
Account Information
GET
/subaccount/{*****@sub-accounts.com}
Transfer credit
POST
/subaccount/credit-transfer/transfer
Transfer credit token
POST
/subaccount/credit-transfer/token

Access to your API configuration

Modify configuration
PATCH
/user/campaign-parameters/edit
Retrieve the configuration
GET
/user/campaign-parameters

Special features

SMS text with reply
POST
/sms-campaign/send
SMS transactional text
POST
/sms-campaign/send
Send with dynamic fields
POST
/sms-campaign/send
Sending SMS by HTTP
POST
/sms-campaign/send
Health Check
GET
/service/health-check

API SMTP

Sending SMS by SMTP
MAILTO:
apismtp@octopush-dm.com