CLclose
phone_numbers

Request an internal phone number

Changed on

Renting a phone number incurs a cost. The new number is assigned to you unless you name other users via assign_to, which requires the "Manage Team Phone Numbers" permission.

If a number was rented, a 201 response is returned with the new number. If no number was rented (4xx response code), the response contains a status field which may contain one of the values below. New statuses may be added in the future.

  • has-voice-only: This country/prefix combination only has non-SMS-capable numbers. You can attempt renting the number by passing with_sms as false.
  • needs-more-info: More information (such as proof of address) is needed to rent this number. This number can only be rented by contacting Close support.
  • billing-error: An error related to billing has occurred. For example, the telephony budget has been reached, or there are not enough funds and recharging failed.
  • error: An error has occurred while renting this number. A human-readable message is returned in the error field.
post/phone_number/request/internal/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/phone_number/request/internal/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Request body

assign_tostring[] nullable

IDs of the users the new phone number is assigned to. When omitted, the number is assigned to the user making the request. Assigning it to anyone else requires the "Manage Team Phone Numbers" permission, and every user must be an active member of the organization who is allowed to make calls.

bundle_idstring nullable
carrier_type'local' | 'national' | 'mobile' | 'tollfree' nullable
countrystring required

A two letter ISO country code (e.g. US for United States).

prefixstring

A string with the phone number prefix or area code, not including the country code.

sharing'personal' | 'group'
with_mmsboolean nullable

By default, MMS-capable numbers are rented if Close supports MMS for the given country. Renting an MMS-capable number can be forced by setting this flag to true. If set to false, certain prefixes that don't support MMS can be rented in countries where Close supports MMS. In most scenarios, this flag should not be passed. When you request an MMS number, you must set with_sms to true as well.

with_smsboolean nullable

By default, SMS-capable numbers are rented if Close supports SMS for the given country. Renting an SMS-capable number can be forced by setting this flag to true. If set to false, certain prefixes that don't support SMS can be rented in countries where Close supports SMS. In most scenarios, this flag should not be passed unless a has-voice-only error status is received.

Response

Successful response

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • 4b8163ed3425Revision changes
    • info

      added the new optional request property