Get notification settings
Senders, their verification state, the SMS price and which events send an SMS or an email. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get notification settings › Responses
The settings.
sms_sender_name^[A-Za-z0-9]{1,11}$ · requiredsms_sender_statusemail_from_address^(?:[A-Za-z0-9_'+\-]… · requiredemail_domain_statussms_price_per_segment_xpfnull until the SMS provider and its price are decided.
Choose which events notify recipients
Events left out keep their rule. The pickup code SMS stays on. Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Choose which events notify recipients › Responses
Every rule.
Set the SMS sender name and the sending email
Allowed to carrier admins only.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Set the SMS sender name and the sending email › Request Body
sms_sender_name^[A-Za-z0-9]{1,11}$ · requiredemail_from_address^(?:[A-Za-z0-9_'+\-]… · requiredSet the SMS sender name and the sending email › Responses
Saved.
Get a message template
The carrier's template, or the shipping.nc default when none is saved. Allowed to carrier admins only.
path Parameters
eventThe event that sends the message.
channelsms or email.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Get a message template › Responses
The template.
eventchannelsubjectbodyis_defaultSave a message template
An email needs a subject, an SMS none. Only the variables of the event are allowed. Allowed to carrier admins only.
path Parameters
eventThe event that sends the message.
channelsms or email.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Save a message template › Request Body
subjectbodySave a message template › Responses
The saved template.
eventchannelsubjectbodyis_defaultRestore the default template
Allowed to carrier admins only.
path Parameters
eventThe event that sends the message.
channelsms or email.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Restore the default template › Responses
The default template.
eventchannelsubjectbodyis_defaultSend a test message
Fills the given template with sample data and sends it to the carrier's contact phone or support email. While no SMS provider is chosen, the message is only logged and delivered is false. Allowed to carrier admins only.
path Parameters
eventThe event that sends the message.
channelsms or email.
Headers
x-correlation-idYour request identifier. Generated when absent, and always echoed in the response header.
Send a test message › Request Body
subjectbodySend a test message › Responses
The test is on its way.
channelsent_toThe phone or email of the carrier contact the test went to.
deliveredfalse while the channel has no provider: the test was only logged.