A valid request URL is required to generate request examples{
"data": {
"provisioning": {
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"storefrontAgentId": "<string>",
"areaCode": "<string>",
"status": "requested",
"phoneNumber": "<string>",
"endpointId": "<string>",
"quotedUpfrontUsdMicros": 4503599627370495,
"quotedMonthlyUsdMicros": 4503599627370495,
"failureCode": "<string>",
"duplicate": true
}
},
"error": null
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Request a text-message line for an Agent
Buy one SMS-capable US number and bind it to one active storefront Agent. Only a signed-in Seller Account administrator may call it: API keys, M2M clients, service tokens, impersonated or simulated sessions, and Apostra staff support access are refused, because the request buys a number from a carrier. A 202 response means the request was saved, not that a number was bought; poll the request to follow it. The price fields limit the carrier’s quote, re-read immediately before the order; the carrier offers no maximum-price field on a number order.
A valid request URL is required to generate request examples{
"data": {
"provisioning": {
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"storefrontAgentId": "<string>",
"areaCode": "<string>",
"status": "requested",
"phoneNumber": "<string>",
"endpointId": "<string>",
"quotedUpfrontUsdMicros": 4503599627370495,
"quotedMonthlyUsdMicros": 4503599627370495,
"failureCode": "<string>",
"duplicate": true
}
},
"error": null
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Body
Idempotency UUID for this intended line. Replaying it with the same body returns the original request instead of buying a second number.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Active storefront Agent that will own the line.
1 - 200US area code to buy the number in.
^[2-9]\d{2}$Highest upfront price accepted from the carrier's own quote for the exact number, re-read immediately before the order. The carrier offers no maximum-price field on a number order, so this is not a carrier-enforced cap.
0 <= x <= 10000Highest recurring price accepted from the carrier's own quote for the exact number, re-read immediately before the order. The carrier offers no maximum-price field on a number order, so this is not a carrier-enforced cap.
0 <= x <= 10000