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
This is the overall, high-level procedure to request a resource:
- Gather data requirements: ensure that you have all the relevant information required 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, the request data is validated against the specific requirements of the request.
- Receive feedback: Infobip team contacts you via email and shares feedback on the status of your request, particularly if data is insufficient or incorrect.
- Update the data for the request: Send an email to provide an update to meet the data requirements.
- Infobip proceeds with the registration/or procurement.
- The 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 via 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)).
- Update resource request.
- Cancel resource request.
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.
You only need to use this endpoint if any of the requirements is 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
To update a request, send an email to Infobip Support, and the Infobip team will reach out to you via Support to obtain the additional data.
Cancel resource request
To cancel a request, send an email to Infobip Support. The Infobip team may contact you to confirm that you wish to go ahead and cancel the request.
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
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.