TextKitDocs

Request a short code (or a toll-free number set up by our team)

Files a request with our team; it provisions nothing by itself.

POST/v1/numbers/requests

Body Parameters

  • typeshort_code, toll_freerequired
  • business_namestringrequired

    At most 120 characters.

  • monthly_volumeunder_1k, 1k_10k, 10k_100k, over_100krequired
  • use_casestringrequired

    What you will send, in a sentence or two. At most 500 characters. At least 10 characters.

Details

We set the number up with you by email. Carriers take 8 to 12 weeks to approve a short code, and its carrier fees are passed through at cost.

One open request per type: asking again updates it. 5 a day per key. Scope: numbers:write.

Responses

  • 201JSON object

    The request

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • objectnumber_request
  • idstring

    Example: short_code.

  • typeshort_code, toll_free
  • business_namestring
  • monthly_volumestring
  • use_casestring
  • statusrequested
  • created_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded