Request resources
Infobip provides several efficient methods for requesting your resources, supplying information about the status, and the progress of the request.
The request procedure ensures compliance with local regulations, enhances brand visibility, and improves message deliverability, for example:
- Regulations and compliance: many resources require country-specific approval and documentation before use, based on country-level compliance
- Branding and recognition: custom sender IDs and numbers help businesses maintain a professional image
- Channel-specific requirements: each channel has different rules for sender identities
Whether you are using the Resources API or the web interface, the steps for requesting resources follows the same high-level procedure.
High-level procedure for requesting resources
Follow the high-level procedure to request a resource:
- Gather data requirements: collect all the relevant information for the request. Some resources require registration or for additional data to be provided. and these are known as data requirements.
- Submit request: use your preferred method to submit the request. After Infobip receives your request, your data is validated against the specific requirements of the request.
- Receive feedback: receive the feedback by one of the following methods:
- Infobip team contacts you by email and shares feedback on the status of your request, particularly if data is missing or incorrect
- For alphanumeric sender requests and number purchases, the system provides automatic validation feedback, either over API or with notification messages in My Requests
- Respond to feedback: update the request to meet the data requirements. Update the request using one of the following methods:
- Send an email to the Infobip team to provide the updated data or amendments for your request
- For alphanumeric senders and number purchases, update the data for the request either over API or in the web interface Requesting resources over web interface, or you can choose to cancel the request
- Processing: Infobip proceeds with the registration/or procurement.
- Completion: your request is complete.
The following table shows the possible supported request statuses.
Request status | Description |
---|---|
Pending | Request is being processed by Infobip. During this phase, the Infobip team may reach out by email for additional data or data updates. |
Rejected | Request has been cancelled by Infobip. |
Completed | Request has completed. |
Requesting resources over API
The Resource Request API supports the following request types:
- Alphanumeric registration
- Number purchase
- Depending on the resource type you select, additional parameters are expected.
The process of requesting resources over API uses the Resource Request endpoints (opens in a new tab) in the following order:
- Get a list of the requirements for the resource (Get requirements endpoint (opens in a new tab)).
- Upload the documents that are required to support the resource request (Upload documents endpoint (opens in a new tab)).
- Submit the request for the resource (Submit resource request endpoint (opens in a new tab)).
- Receive update notifications on the status of the request submission (Receive resource requests status updates webhook (opens in a new tab)).
- For alphanumeric sender requests: updates for your alphanumeric sender request with required additional data Update resource request endpoint (opens in a new tab)
- For alphanumeric sender requests: if you no longer wish to proceed with the alphanumeric sender request, you can cancel your request Cancel resource request endpoint (opens in a new tab)
Update and Cancel request for alphanumeric senders is available to selected accounts only. To start using this feature, contact Support (opens in a new tab) or your Infobip account manager.
When you request resources, you are provided with visibility of the request status so that you know when you need to carry out an action.
The following table shows the possible supported statuses for when requesting resources over API.
API status | Description |
---|---|
PENDING | Request is being processed by Infobip. During this phase, the Infobip team may reach out by email for additional data or data updates. |
AUTOMATIC_VALIDATION | This status is applicable for both alphanumeric sender requests (ALPHANUMERIC_REGISTRATION ) and number purchases (NUMBER_PURCHASE ). Request is currently undergoing automatic validation of the provided requirements data. This process checks the data format, ensuring it meets the maximum and minimum length or value limits, verifies all mandatory fields are present, and confirms compliance with regular expressions. |
UPDATE_REQUESTED | This status is applicable for both alphanumeric sender requests (ALPHANUMERIC_REGISTRATION ) and number purchases (NUMBER_PURCHASE ). Automatic validation has identified issues with the provided requirements data, and this requires the request to be updated. Validation feedback is returned from a Get resource request in the requirementsFeedback array of objects. |
REJECTED | Infobip has rejected the request. |
CANCELED | This status is applicable for both alphanumeric sender requests (ALPHANUMERIC_REGISTRATION ) and number purchases (NUMBER_PURCHASE ). Request has been cancelled. |
COMPLETED | Request has completed. |
Get requirements
Use the Get requirements endpoint (opens in a new tab) to get the list of all relevant requirements for a specific request type. In the request, you specify the type of resource (number or alphanumeric sender) and the associated required parameters. For example:
ALPHANUMERIC_REGISTRATION
- specify the two-letter country codeNUMBER_PURCHASE
- specify the country code, and also the number type (SHORT_CODE
,VIRTUAL_LONG_NUMBER
,TEN_DIGIT_LONG_CODE
,TOLL_FREE_NUMBER
) and capabilities (SMS
,VOICE
,MMS
).
The API returns a list of required data fields that must be provided when requesting the specified resource. The resource types are TEXT
, INTEGER
, EMAIL
, URL
, GSM
, and DOCUMENT
.
The request is validated to check the syntax, authorization, and permissions, and returns an error to indicate any violations. If any required field is missing, the request is rejected or requires additional input. In addition, TEXT
and INTEGER
can specify the following validation rules:
- TEXT - minimum length, maximum length, and the pattern of the string
- INTEGER - minimum value and maximum value
The following table shows the potential responses to this endpoint.
Response | Resource | Request |
---|---|---|
No requirements needed | Numbers | If an empty object is returned, the number does not require any additional documentation or data to proceed with the request. |
No offer | Numbers | The number has no appropriate offers available. The following error code is returned RES-NUM-LOOKUP404 . |
No registration | Alphanumeric senders | Alphanumeric registration is not currently available. This may be because the country allows any sender to be used, or alphanumeric senders are not supported overall. For more information, see SMS Coverage and Connectivity. |
You then use this information to gather the required data before submitting a request.
Upload document
Use the Upload documents endpoint (opens in a new tab) to upload a document so that it can be used as a requirement within a resource request.
Use this endpoint only if any of the requirements are of type DOCUMENT
.
This endpoint returns an ID in response, which is then submitted with the API request.
Submit resource request
Use the Submit resource request endpoint (opens in a new tab) to submit a request with valid requirements data. You may be charged for the request, depending on the specific number or alphanumeric sender charging.
Some numbers do not require additional data. Use Get requirements (opens in a new tab) for all the necessary data.
For 10DLC (number type TEN_DIGIT_LONG_CODE
), if you want to use a number that belongs to a specific state or with a specific npa or nxx, you can provide information about the state, npa, or nxx within the requirements object.
Receive updates webhook
You can be notified of any changes to the resource request status using the Receive resource requests status updates webhook (opens in a new tab).
When there is a change in the status, the webhook returns an event specifying the status of the request. For example, COMPLETED
or REJECTED
.
Update resource request
You can update a request by sending an email to Infobip Support outlining the changes and new data. The Infobip Support team then reaches out to you to obtain the additional data.
When requesting alphanumeric senders (ALPHANUMERIC_REGISTRATION
) or number purchases (NUMBER_PURCHASE
), automatic validation may identify issues with the supplied requirements data. You are informed about any issues in the requirementsFeedback
array of objects from a Get resource request (opens in a new tab).
Cancel resource request
You can cancel a request by sending an email to Infobip Support. The Infobip team may contact you to confirm that you wish to go ahead and cancel the request.
When a request for alphanumeric senders (ALPHANUMERIC_REGISTRATION
) or number purchases (NUMBER_PURCHASE
) is in UPDATE_REQUESTED
status, you can submit a request to cancel using the Cancel resource request endpoint (opens in a new tab) and the request identifier. When canceling an existing request over API, this cancels the request with Infobip.
Requesting resources over web interface
You can request resources from Channels and Numbers in the Infobip web interface (opens in a new tab). Login using your Infobip account, go to Channels and Numbers and select either Channels, Numbers, or My requests.
For example, you can:
- Buy a number from Numbers
- Request an alphanumeric sender from Channels > SMS
- Request a channel or sender from My requests
When you request resources, you are provided with visibility of the request status so that you know when you need to carry out an action.
The following table shows the possible supported statuses when requesting resources over the web interface.
Request status | Status icon color | Description |
---|---|---|
Pending | Yellow | Request is being processed by Infobip. During this phase, the Infobip team may reach out by email for additional data or data updates. |
Action required | Red | Automatic validation has identified issues with the requirements data that was provided, and this requires the request to be updated. When requests are in this status, there is the option to cancel. |
Rejected | Red | Request has been rejected by Infobip. |
Canceled | Grey | Request has been cancelled. |
Completed | Green | Request has completed. |
Update and Cancel request for alphanumeric senders or number purchases is available to selected accounts only. To start using this feature, contact Support (opens in a new tab) or your Infobip account manager.
Buy number from Numbers
To buy numbers from Numbers in Channels and Numbers:
- Go to Channels and Numbers > Numbers.
- Click Buy Number.
- For more information, see Buy numbers.
Request alphanumeric sender from SMS
To request an alphanumeric sender from SMS in Channels and Numbers:
- Go to Channels and Numbers > Channels > SMS.
- Under Alphanumeric Sender ID, click Request Sender.
- For more information, see Submit MyRequests.
Request channel from My requests
To request a channel or a sender from My requests in Channels and Numbers:
- Go to Channels and Numbers > My requests.
- Click Request Channel.
- For more information, see Submit MyRequests.