This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
No device delivery receipt found. This can happen for one of the following reasons: * the customer never requested device delivery receipts ( `requireDeliveryReceipt` was never set to `true` in `Send SMS` ), * the customer specified a destination and doesn't have any device delivery receipts for that destination, * the device delivery receipts are expired, i.e. the `Send SMS` calls which generated the requested delivery receipts were made more than 7 days ago.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/sms",
"detail": "The following MSISDN is invalid: 123456789.
A MSISDN must be a 10 digit number optionally prefixed with 1 or +1"
}
403
No Configuration
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/sms",
"detail": "The customer must be configured before sending an SMS"
}
401
The customer doesn't have access to this API: no `sms` scope.
500
Internal Server Error
Retrieve Customer Delivery Receipts
Path
GET /notifications
destination
A destination MSISDN.
Optional in Query
+11234567895
string
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
No device delivery receipt found. This can happen for one of the following reasons: * the customer never requested device delivery receipts ( `requireDeliveryReceipt` was never set to `true` in `Send SMS` ), * the customer specified a destination and doesn't have any device delivery receipts for that destination, * the device delivery receipts are expired, i.e. the `Send SMS` calls which generated the requested delivery receipts were made more than 7 days ago.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/sms",
"detail": "The following MSISDN is invalid: 123456789.
A MSISDN must be a 10 digit number optionally prefixed with 1 or +1"
}
401
The customer doesn't have access to this API: no `sms` scope.
403
The customer can't be authenticated because the JWT token is invalid.
500
Internal Server Error
Retrieve Message Delivery Receipts
Path
GET /notifications/{messageId}
messageId
A system-generated unique message identifier. This identifier is generated during a `Send SMS` request that has the `requireDeliveryReceipt` flag set to `true`.
Required in Path
6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b
string
destination
A destination MSISDN.
Optional in Query
+11234567895
string
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
No device delivery receipt found. This can happen for one of the following reasons: * the customer didn't request device delivery receipts for this message ( `requireDeliveryReceipt` was not set to `true` in `Send SMS` ), * the message id doesn't exist, * the customer specified a destination to which the message was not sent, * the device delivery receipts are expired, i.e. the `Send SMS` call which generated the requested delivery receipts was made more than 7 days ago.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/sms",
"detail": "The following MSISDN is invalid: 123456789.
A MSISDN must be a 10 digit number optionally prefixed with 1 or +1"
}
401
The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `sms` scope, * the message id doesn't belong to the customer.
403
The customer can't be authenticated because the JWT token is invalid.
500
Internal Server Error
Create Configuration
Path
POST /notifications/configuration
configuration
SMS configuration
Required in body
{
"companyName": "A company name",
"notifyUrl": "https://customerNotificationURL",
"destinations": [
"1234567895",
"11234567894",
"+11234567892"
]
}
object
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string
Content-Type
application/json
Optional in header
string
202
SMS configured for IoT devices and opt-in messages have been sent for mobile devices.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/configuration",
"detail": "The 'companyName' property is required"
}
403
Already Configured
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "The customer is already configured"
}
403
URL Already Registered
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "The 'notifyUrl' is already registered by another customer"
}
403
Destination(s) Already Registered
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "At least one destination is already registered by another customer"
}
401
The customer doesn't have access to this API: no `sms` scope.
500
Internal Server Error
Retrieve Configuration
Path
GET /notifications/configuration
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/configuration",
"detail": "The 'companyName' property is required"
}
403
The customer can't be authenticated because the JWT token is invalid.
401
The customer doesn't have access to this API: no `sms` scope.
500
Internal Server Error
Delete Configuration
Path
DELETE /notifications/configuration
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string
204
The request has been fulfilled.
403
The request cannot be completed for one of the following reasons: * the customer can't be authenticated because the JWT token is invalid, * there is no configuration stored for this customer.
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "No configuration was registered for this customer"
}
401
The customer doesn't have access to this API: no `sms` scope.
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/email",
"detail": "The 'destinations' property is required"
}
403
The customer can't be authenticated because the JWT token is invalid.
401
The customer doesn't have access to this API: no `email` scope.
500
Internal Server Error
Business overview
This API provides the ability to send notifications via email and send / receive SMS messages from Bell mobile and IoT devices.
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
No device delivery receipt found. This can happen for one of the following reasons: * the customer never requested device delivery receipts ( `requireDeliveryReceipt` was never set to `true` in `Send SMS` ), * the customer specified a destination and doesn't have any device delivery receipts for that destination, * the device delivery receipts are expired, i.e. the `Send SMS` calls which generated the requested delivery receipts were made more than 7 days ago.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/sms",
"detail": "The following MSISDN is invalid: 123456789.
A MSISDN must be a 10 digit number optionally prefixed with 1 or +1"
}
403
No Configuration
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/sms",
"detail": "The customer must be configured before sending an SMS"
}
401
The customer doesn't have access to this API: no `sms` scope.
500
Internal Server Error
Retrieve Customer Delivery Receipts
Path
GET /notifications
destination
A destination MSISDN.
Optional in Query
+11234567895
string
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
No device delivery receipt found. This can happen for one of the following reasons: * the customer never requested device delivery receipts ( `requireDeliveryReceipt` was never set to `true` in `Send SMS` ), * the customer specified a destination and doesn't have any device delivery receipts for that destination, * the device delivery receipts are expired, i.e. the `Send SMS` calls which generated the requested delivery receipts were made more than 7 days ago.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/sms",
"detail": "The following MSISDN is invalid: 123456789.
A MSISDN must be a 10 digit number optionally prefixed with 1 or +1"
}
401
The customer doesn't have access to this API: no `sms` scope.
403
The customer can't be authenticated because the JWT token is invalid.
500
Internal Server Error
Retrieve Message Delivery Receipts
Path
GET /notifications/{messageId}
messageId
A system-generated unique message identifier. This identifier is generated during a `Send SMS` request that has the `requireDeliveryReceipt` flag set to `true`.
Required in Path
6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b
string
destination
A destination MSISDN.
Optional in Query
+11234567895
string
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
No device delivery receipt found. This can happen for one of the following reasons: * the customer didn't request device delivery receipts for this message ( `requireDeliveryReceipt` was not set to `true` in `Send SMS` ), * the message id doesn't exist, * the customer specified a destination to which the message was not sent, * the device delivery receipts are expired, i.e. the `Send SMS` call which generated the requested delivery receipts was made more than 7 days ago.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/sms",
"detail": "The following MSISDN is invalid: 123456789.
A MSISDN must be a 10 digit number optionally prefixed with 1 or +1"
}
401
The customer can't access this information for one of the following reasons: * the customer doesn't have access to this API: no `sms` scope, * the message id doesn't belong to the customer.
403
The customer can't be authenticated because the JWT token is invalid.
500
Internal Server Error
Create Configuration
Path
POST /notifications/configuration
configuration
SMS configuration
Required in body
{
"companyName": "A company name",
"notifyUrl": "https://customerNotificationURL",
"destinations": [
"1234567895",
"11234567894",
"+11234567892"
]
}
object
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string
Content-Type
application/json
Optional in header
string
202
SMS configured for IoT devices and opt-in messages have been sent for mobile devices.
400
Bad Request
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/configuration",
"detail": "The 'companyName' property is required"
}
403
Already Configured
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "The customer is already configured"
}
403
URL Already Registered
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "The 'notifyUrl' is already registered by another customer"
}
403
Destination(s) Already Registered
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "At least one destination is already registered by another customer"
}
401
The customer doesn't have access to this API: no `sms` scope.
500
Internal Server Error
Retrieve Configuration
Path
GET /notifications/configuration
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/configuration",
"detail": "The 'companyName' property is required"
}
403
The customer can't be authenticated because the JWT token is invalid.
401
The customer doesn't have access to this API: no `sms` scope.
500
Internal Server Error
Delete Configuration
Path
DELETE /notifications/configuration
correlationId
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
Optional In Header
string
204
The request has been fulfilled.
403
The request cannot be completed for one of the following reasons: * the customer can't be authenticated because the JWT token is invalid, * there is no configuration stored for this customer.
{
"type": "https://api.iot.bell.ca/business-error",
"title": "The action can't be performed",
"instance": "/notifications/configuration",
"detail": "No configuration was registered for this customer"
}
401
The customer doesn't have access to this API: no `sms` scope.
This is an identifier that can be provided by the client to enable requests correlation. * If the header is not present, a correlation id is generated by the API and the correlation is restricted to the server-side. * If the header is present, the correlation encompasses both client-side and server-side. A different correlation id should be provided for each request.
{
"type": "https://api.iot.bell.ca/validation-error",
"title": "The request is invalid",
"instance": "/notifications/email",
"detail": "The 'destinations' property is required"
}
403
The customer can't be authenticated because the JWT token is invalid.
401
The customer doesn't have access to this API: no `email` scope.
Back to top