Requirement Groups

Create a new requirement group

Changed on

Creates a regulatory requirement group for a country, number type, and ordering or porting action. Optional customer-reference and requirement values are retained on the created group.

post/requirement_groups

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/requirement_groups
  • Auth: HTTP bearer

Request body

country_codestring required

ISO alpha 2 country code

phone_number_type'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost' required
action'ordering' | 'porting' required
customer_referencestring

Example request

{
  "country_code": "US",
  "phone_number_type": "local",
  "action": "ordering",
  "customer_reference": "My Requirement Group"
}

Response

Requirement group created

idstring
country_codestring
phone_number_typestring
status'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired'
actionstring
customer_referencestring
created_atstring date-time
updated_atstring date-time
record_typestring

Example response

{
  "record_type": "requirement_group"
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status