This API describes the set of endpoints available to get each market requirements and create registration for sender IDs.
The list of endpoints allows to create, update and delete a registration and also get the current state. For each market, customers can check the different requirements depending on the new sender ID scope, and also download templates to fill in for the registrations.
Interested in this API? Please, reach out to your Account Manager for more info.
https://senderid.registrations.api.sinch.com/
https://senderid.numbers-registration.staging.sinch.com/
You can set up callback URLs to receive event notifications when your registration status is updated. When delivering events the order is not guaranteed (for example, a failed event scheduled for retry will not block other events that were queued). The client's callback handler must implement the state machine that can decide what to do with unexpected events, for example, "old" events or invalid state transitions. In these cases the handler could use the API to GET the latest state for the resource. The callback handler is expected to "ingest" the event and respond with 200 OK. The domain-specific business logic and processes should be executed outside of the callback request, as internal asynchronous jobs. An HMAC encrypted secret is used for hashing the payload and sending the hashed String via the X-Sinch-Signature header - that you can use to validate that an incoming request is secure. Hmac secret value can be checked with GET endpoint, and it can be updated with PUT endpoint
https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/policies/{policyId}
https://senderid.numbers-registration.staging.sinch.com/v1/projects/{projectId}/policies/{policyId}
curl -i -X GET \
'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/policies/{policyId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
Indicates whether the policy accepts single or multi sender id requested in each registration process
| Enum Value | Description |
|---|---|
| SINGLE | Only one sender ID is allowed per registration. |
| MULTI_SENDER | Up to 50 sender IDs are allowed per registration. They can be included in the senderIdDetails array (one object per sender ID) |
Policy status
| Enum Value | Description |
|---|---|
| ENABLED | Policy is in use. |
| DISABLED | Policies that for any reason has been deactivated. There are several reasons to do so, but they are mainly due to changes in the regulations, which require some manual intervention. |
| INACTIVE | Market version has been deactivated because a new version has been published. This policy is no longer valid. |
Indicates if the policy has open registration system. This means that any sender ID requested is automatically approved, without any manual intervention.
Contains disclaimer for disabled policies. Empty if policy is ACTIVE
{ "attachments": [ { … } ], "fees": true, "id": "43342642354352344", "jsonPolicy": { "companyDetailsTemplate": { … }, "contactPersonTemplate": { … }, "senderIdTemplate": { … }, "marketSpecificDetailsTemplate": { … } }, "policyMultiType": "SINGLE", "policyStatus": "ENABLED", "price": { "mode": "SUBSCRIBED", "subscription": { … } }, "isOpenPolicy": true, "statusDisclaimer": "Policy has been disabled as Registrations for these market conditions are now dynamic." }
https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/policies/{policyId}/attachments/{attachmentId}/template
https://senderid.numbers-registration.staging.sinch.com/v1/projects/{projectId}/policies/{policyId}/attachments/{attachmentId}/template
curl -i -X GET \
https://senderid.registrations.api.sinch.com/v1/projects/eeew32344324edewe2e3/policies/43342642354352344/attachments/324234762423034240/template \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'No content