{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:telnyx/create-bulk-telephony-credential":{"post":{"operationId":"communication_telnyx_create_bulk_telephony_credential","summary":"Creates several credentials","description":"POST /actions/bulk/telephony_credentials","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-bulk-telephony-credential":{"post":{"operationId":"communication_telnyx_update_bulk_telephony_credential","summary":"Update several credentials","description":"PATCH /actions/bulk/telephony_credentials","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filter[tag]","body"],"properties":{"filter[tag]":{"type":"string","description":"Filter by tag, required by bulk operations."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-bulk-telephony-credential":{"post":{"operationId":"communication_telnyx_delete_bulk_telephony_credential","summary":"Delete several credentials","description":"DELETE /actions/bulk/telephony_credentials","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["filter[tag]"],"properties":{"filter[tag]":{"type":"string","description":"Filter by tag, required by bulk operations."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/bulk-simcard-network-preferences":{"post":{"operationId":"communication_telnyx_bulk_simcard_network_preferences","summary":"Bulk Network Preferences for SIM cards","description":"PUT /actions/network_preferences/sim_cards","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-register":{"post":{"operationId":"communication_telnyx_sim_card_register","summary":"Register SIM cards","description":"POST /actions/register/sim_cards","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/bulk-credential-action":{"post":{"operationId":"communication_telnyx_bulk_credential_action","summary":"Perform activate or deactivate action on all credentials filtered by the provided tag.","description":"POST /actions/{action}/telephony_credentials","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action","filter[tag]"],"properties":{"action":{"type":"string","enum":["activate","deactivate"],"description":"Identifies the action to be taken. Activate will change the status to active. Deactivate will change the status to inactive."},"filter[tag]":{"type":"string","description":"Filter by tag, required by bulk operations."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-addresss":{"get":{"operationId":"communication_telnyx_find_addresss","summary":"List all addresses","description":"GET /addresses","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[customer_reference][eq]","in":"query","required":false,"description":"Filter addresses via the customer reference set. Matching is not case-sensitive.","schema":{"type":"string","description":"Filter addresses via the customer reference set. Matching is not case-sensitive."}},{"name":"filter[customer_reference][contains]","in":"query","required":false,"description":"If present, addresses with customer_reference containing the given value will be returned. Matching is not case-sensitive.","schema":{"type":"string","description":"If present, addresses with customer_reference containing the given value will be returned. Matching is not case-sensitive."}},{"name":"filter[used_as_emergency]","in":"query","required":false,"description":"If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false',…","schema":{"type":"string","default":"null","description":"If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false',…"}},{"name":"filter[street_address][contains]","in":"query","required":false,"description":"If present, addresses with street_address containing the given value will be returned. Matching is not case-sensitive. Requires at least…","schema":{"type":"string","default":"null","description":"If present, addresses with street_address containing the given value will be returned. Matching is not case-sensitive. Requires at least…"}},{"name":"filter[address_book][eq]","in":"query","required":false,"description":"If present, only returns results with the address_book flag set to the given value.","schema":{"type":"string","default":"null","description":"If present, only returns results with the address_book flag set to the given value."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","first_name","last_name","business_name","street_address"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-address":{"post":{"operationId":"communication_telnyx_create_address","summary":"Creates an address","description":"POST /addresses","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/validate-address":{"post":{"operationId":"communication_telnyx_validate_address","summary":"Validate an address","description":"POST /addresses/actions/validate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-address":{"get":{"operationId":"communication_telnyx_get_address","summary":"Retrieve an address","description":"GET /addresses/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"address ID","schema":{"type":"string","description":"address ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-address":{"post":{"operationId":"communication_telnyx_delete_address","summary":"Deletes an address","description":"DELETE /addresses/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"address ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-authentication-providers":{"get":{"operationId":"communication_telnyx_find_authentication_providers","summary":"List all SSO authentication providers","description":"GET /authentication_providers","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["name","-name","short_name","-short_name","active","-active","created_at","-created_at","updated_at","-updated_at"],"default":"-created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-authentication-provider":{"post":{"operationId":"communication_telnyx_create_authentication_provider","summary":"Creates an authentication provider","description":"POST /authentication_providers","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-authentication-provider":{"get":{"operationId":"communication_telnyx_get_authentication_provider","summary":"Retrieve an authentication provider","description":"GET /authentication_providers/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"authentication provider ID","schema":{"type":"string","description":"authentication provider ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-authentication-provider":{"post":{"operationId":"communication_telnyx_update_authentication_provider","summary":"Update a authentication provider","description":"PATCH /authentication_providers/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-authentication-provider":{"post":{"operationId":"communication_telnyx_delete_authentication_provider","summary":"Deletes an authentication provider","description":"DELETE /authentication_providers/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"authentication provider ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-available-phone-number-blocks":{"get":{"operationId":"communication_telnyx_list_available_phone_number_blocks","summary":"List available phone number blocks","description":"GET /available_phone_number_blocks","tags":["communication"],"parameters":[{"name":"filter[phone_number][starts_with]","in":"query","required":false,"description":"Filter number blocks that start with a pattern (meant to be used after `national_destination_code` filter has been set).","schema":{"type":"string","description":"Filter number blocks that start with a pattern (meant to be used after `national_destination_code` filter has been set)."}},{"name":"filter[phone_number][ends_with]","in":"query","required":false,"description":"Filter numbers ending with a pattern.","schema":{"type":"string","description":"Filter numbers ending with a pattern."}},{"name":"filter[phone_number][contains]","in":"query","required":false,"description":"Filter numbers containing a pattern.","schema":{"type":"string","description":"Filter numbers containing a pattern."}},{"name":"filter[locality]","in":"query","required":false,"description":"Filter phone numbers by city.","schema":{"type":"string","description":"Filter phone numbers by city."}},{"name":"filter[administrative_area]","in":"query","required":false,"description":"Filter phone numbers by US state/CA province.","schema":{"type":"string","description":"Filter phone numbers by US state/CA province."}},{"name":"filter[country_code]","in":"query","required":false,"description":"Filter phone numbers by ISO alpha-2 country code.","schema":{"type":"string","description":"Filter phone numbers by ISO alpha-2 country code."}},{"name":"filter[national_destination_code]","in":"query","required":false,"description":"Filter by the national destination code of the number. This filter is only applicable to North American numbers.","schema":{"type":"string","description":"Filter by the national destination code of the number. This filter is only applicable to North American numbers."}},{"name":"filter[rate_center]","in":"query","required":false,"description":"Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers.","schema":{"type":"string","description":"Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers."}},{"name":"filter[number_type]","in":"query","required":false,"description":"Filter phone numbers by number type.","schema":{"type":"string","enum":["toll-free"],"description":"Filter phone numbers by number type."}},{"name":"filter[features]","in":"query","required":false,"description":"Filter if the phone number should be used for voice, fax, mms, sms, emergency.","schema":{"type":"array","description":"Filter if the phone number should be used for voice, fax, mms, sms, emergency."}},{"name":"filter[minimum_block_size]","in":"query","required":false,"description":"Filter number blocks by minimum blocks size","schema":{"type":"integer","description":"Filter number blocks by minimum blocks size"}},{"name":"filter[limit]","in":"query","required":false,"description":"Limits the number of results.","schema":{"type":"integer","description":"Limits the number of results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-available-phone-numbers":{"get":{"operationId":"communication_telnyx_list_available_phone_numbers","summary":"List available phone numbers","description":"GET /available_phone_numbers","tags":["communication"],"parameters":[{"name":"filter[phone_number][starts_with]","in":"query","required":false,"description":"Filter numbers starting with a pattern (meant to be used after `national_destination_code` filter has been set).","schema":{"type":"string","description":"Filter numbers starting with a pattern (meant to be used after `national_destination_code` filter has been set)."}},{"name":"filter[phone_number][ends_with]","in":"query","required":false,"description":"Filter numbers ending with a pattern.","schema":{"type":"string","description":"Filter numbers ending with a pattern."}},{"name":"filter[phone_number][contains]","in":"query","required":false,"description":"Filter numbers containing a pattern.","schema":{"type":"string","description":"Filter numbers containing a pattern."}},{"name":"filter[locality]","in":"query","required":false,"description":"Filter phone numbers by city.","schema":{"type":"string","description":"Filter phone numbers by city."}},{"name":"filter[administrative_area]","in":"query","required":false,"description":"Filter phone numbers by US state/CA province.","schema":{"type":"string","description":"Filter phone numbers by US state/CA province."}},{"name":"filter[country_code]","in":"query","required":false,"description":"Filter phone numbers by ISO alpha-2 country code.","schema":{"type":"string","description":"Filter phone numbers by ISO alpha-2 country code."}},{"name":"filter[national_destination_code]","in":"query","required":false,"description":"Filter by the national destination code of the number. This filter is only applicable to North American numbers.","schema":{"type":"string","description":"Filter by the national destination code of the number. This filter is only applicable to North American numbers."}},{"name":"filter[rate_center]","in":"query","required":false,"description":"Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers.","schema":{"type":"string","description":"Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers."}},{"name":"filter[number_type]","in":"query","required":false,"description":"Filter phone numbers by number type.","schema":{"type":"string","enum":["toll-free","national","mobile","local"],"description":"Filter phone numbers by number type."}},{"name":"filter[features]","in":"query","required":false,"description":"Filter if the phone number should be used for voice, fax, mms, sms, emergency.","schema":{"type":"array","description":"Filter if the phone number should be used for voice, fax, mms, sms, emergency."}},{"name":"filter[limit]","in":"query","required":false,"description":"Limits the number of results.","schema":{"type":"integer","description":"Limits the number of results."}},{"name":"filter[best_effort]","in":"query","required":false,"description":"Filter to determine if best effort results should be included.","schema":{"type":"boolean","description":"Filter to determine if best effort results should be included."}},{"name":"filter[quickship]","in":"query","required":false,"description":"Filter to exclude phone numbers that need additional time after to purchase to receive phone calls.","schema":{"type":"boolean","description":"Filter to exclude phone numbers that need additional time after to purchase to receive phone calls."}},{"name":"filter[reservable]","in":"query","required":false,"description":"Filter to exclude phone numbers that cannot be reserved before purchase.","schema":{"type":"boolean","description":"Filter to exclude phone numbers that cannot be reserved before purchase."}},{"name":"filter[exclude_held_numbers]","in":"query","required":false,"description":"Filter to exclude phone numbers that are currently on hold for your account.","schema":{"type":"boolean","description":"Filter to exclude phone numbers that are currently on hold for your account."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-user-balance":{"get":{"operationId":"communication_telnyx_get_user_balance","summary":"Retrieve user balance details","description":"GET /balance","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-billing-groups":{"get":{"operationId":"communication_telnyx_list_billing_groups","summary":"List all billing groups","description":"GET /billing_groups","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-billing-group":{"post":{"operationId":"communication_telnyx_create_billing_group","summary":"Create a billing group","description":"POST /billing_groups","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-billing-group":{"get":{"operationId":"communication_telnyx_retrieve_billing_group","summary":"Retrieve a billing group","description":"GET /billing_groups/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the billing group","schema":{"type":"string","description":"The id of the billing group"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-billing-group":{"post":{"operationId":"communication_telnyx_update_billing_group","summary":"Update a billing group","description":"PATCH /billing_groups/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The id of the billing group"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-billing-group":{"post":{"operationId":"communication_telnyx_delete_billing_group","summary":"Delete a billing group","description":"DELETE /billing_groups/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the billing group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-call-control-applications":{"get":{"operationId":"communication_telnyx_list_call_control_applications","summary":"List call control applications","description":"GET /call_control_applications","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[application_name][contains]","in":"query","required":false,"description":"If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at…","schema":{"type":"string","default":"null","description":"If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at…"}},{"name":"filter[outbound_voice_profile_id]","in":"query","required":false,"description":"Identifies the associated outbound voice profile.","schema":{"type":"string","description":"Identifies the associated outbound voice profile."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","connection_name","active"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-call-control-application":{"post":{"operationId":"communication_telnyx_create_call_control_application","summary":"Create a call control application","description":"POST /call_control_applications","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-call-control-application":{"get":{"operationId":"communication_telnyx_retrieve_call_control_application","summary":"Retrieve a call control application","description":"GET /call_control_applications/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-call-control-application":{"post":{"operationId":"communication_telnyx_update_call_control_application","summary":"Update a call control application","description":"PATCH /call_control_applications/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-call-control-application":{"post":{"operationId":"communication_telnyx_delete_call_control_application","summary":"Delete a call control application","description":"DELETE /call_control_applications/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-call-events":{"get":{"operationId":"communication_telnyx_list_call_events","summary":"List call events","description":"GET /call_events","tags":["communication"],"parameters":[{"name":"filter[call_leg_id]","in":"query","required":false,"description":"The unique identifier of an individual call leg.","schema":{"type":"string","description":"The unique identifier of an individual call leg."}},{"name":"filter[call_session_id]","in":"query","required":false,"description":"The unique identifier of the call control session. A session may include multiple call leg events.","schema":{"type":"string","description":"The unique identifier of the call control session. A session may include multiple call leg events."}},{"name":"filter[status]","in":"query","required":false,"description":"Event status","schema":{"type":"string","enum":["delivered","failed"],"description":"Event status"}},{"name":"filter[type]","in":"query","required":false,"description":"Event type","schema":{"type":"string","enum":["command","webhook"],"description":"Event type"}},{"name":"filter[event_timestamp][gt]","in":"query","required":false,"description":"Event timestamp: greater than","schema":{"type":"string","description":"Event timestamp: greater than"}},{"name":"filter[event_timestamp][gte]","in":"query","required":false,"description":"Event timestamp: greater than or equal","schema":{"type":"string","description":"Event timestamp: greater than or equal"}},{"name":"filter[event_timestamp][lt]","in":"query","required":false,"description":"Event timestamp: lower than","schema":{"type":"string","description":"Event timestamp: lower than"}},{"name":"filter[event_timestamp][lte]","in":"query","required":false,"description":"Event timestamp: lower than or equal","schema":{"type":"string","description":"Event timestamp: lower than or equal"}},{"name":"filter[event_timestamp][eq]","in":"query","required":false,"description":"Event timestamp: equal","schema":{"type":"string","description":"Event timestamp: equal"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-dial":{"post":{"operationId":"communication_telnyx_call_dial","summary":"Dial","description":"POST /calls","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-call-status":{"get":{"operationId":"communication_telnyx_retrieve_call_status","summary":"Retrieve a call status","description":"GET /calls/{call_control_id}","tags":["communication"],"parameters":[{"name":"call_control_id","in":"query","required":true,"description":"Unique identifier and token for controlling the call","schema":{"type":"string","description":"Unique identifier and token for controlling the call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-answer":{"post":{"operationId":"communication_telnyx_call_answer","summary":"Answer call","description":"POST /calls/{call_control_id}/actions/answer","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-bridge":{"post":{"operationId":"communication_telnyx_call_bridge","summary":"Bridge calls","description":"POST /calls/{call_control_id}/actions/bridge","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-enqueue":{"post":{"operationId":"communication_telnyx_call_enqueue","summary":"Enqueue call","description":"POST /calls/{call_control_id}/actions/enqueue","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-fork-start":{"post":{"operationId":"communication_telnyx_call_fork_start","summary":"Forking start","description":"POST /calls/{call_control_id}/actions/fork_start","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-fork-stop":{"post":{"operationId":"communication_telnyx_call_fork_stop","summary":"Forking stop","description":"POST /calls/{call_control_id}/actions/fork_stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-gather-stop":{"post":{"operationId":"communication_telnyx_call_gather_stop","summary":"Gather stop","description":"POST /calls/{call_control_id}/actions/gather_stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-gather-using-audio":{"post":{"operationId":"communication_telnyx_call_gather_using_audio","summary":"Gather using audio","description":"POST /calls/{call_control_id}/actions/gather_using_audio","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-gather-using-speak":{"post":{"operationId":"communication_telnyx_call_gather_using_speak","summary":"Gather using speak","description":"POST /calls/{call_control_id}/actions/gather_using_speak","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-hangup":{"post":{"operationId":"communication_telnyx_call_hangup","summary":"Hangup call","description":"POST /calls/{call_control_id}/actions/hangup","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/leave-queue":{"post":{"operationId":"communication_telnyx_leave_queue","summary":"Remove call from a queue","description":"POST /calls/{call_control_id}/actions/leave_queue","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-playback-start":{"post":{"operationId":"communication_telnyx_call_playback_start","summary":"Play audio URL","description":"POST /calls/{call_control_id}/actions/playback_start","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-playback-stop":{"post":{"operationId":"communication_telnyx_call_playback_stop","summary":"Stop audio playback","description":"POST /calls/{call_control_id}/actions/playback_stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-record-pause":{"post":{"operationId":"communication_telnyx_call_record_pause","summary":"Record pause","description":"POST /calls/{call_control_id}/actions/record_pause","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-record-resume":{"post":{"operationId":"communication_telnyx_call_record_resume","summary":"Record resume","description":"POST /calls/{call_control_id}/actions/record_resume","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-record-start":{"post":{"operationId":"communication_telnyx_call_record_start","summary":"Recording start","description":"POST /calls/{call_control_id}/actions/record_start","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-record-stop":{"post":{"operationId":"communication_telnyx_call_record_stop","summary":"Recording stop","description":"POST /calls/{call_control_id}/actions/record_stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-refer":{"post":{"operationId":"communication_telnyx_call_refer","summary":"SIP Refer a call","description":"POST /calls/{call_control_id}/actions/refer","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-reject":{"post":{"operationId":"communication_telnyx_call_reject","summary":"Reject a call","description":"POST /calls/{call_control_id}/actions/reject","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-send-dtmf":{"post":{"operationId":"communication_telnyx_call_send_dtmf","summary":"Send DTMF","description":"POST /calls/{call_control_id}/actions/send_dtmf","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-speak":{"post":{"operationId":"communication_telnyx_call_speak","summary":"Speak text","description":"POST /calls/{call_control_id}/actions/speak","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-transcription-start":{"post":{"operationId":"communication_telnyx_call_transcription_start","summary":"Transcription start","description":"POST /calls/{call_control_id}/actions/transcription_start","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-transcription-stop":{"post":{"operationId":"communication_telnyx_call_transcription_stop","summary":"Transcription stop","description":"POST /calls/{call_control_id}/actions/transcription_stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/call-transfer":{"post":{"operationId":"communication_telnyx_call_transfer","summary":"Transfer call","description":"POST /calls/{call_control_id}/actions/transfer","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["call_control_id","body"],"properties":{"call_control_id":{"type":"string","description":"Unique identifier and token for controlling the call"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-comments":{"get":{"operationId":"communication_telnyx_list_comments","summary":"Retrieve all comments","description":"GET /comments","tags":["communication"],"parameters":[{"name":"filter[comment_record_type]","in":"query","required":true,"description":"Record type that the comment relates to i.e number_order, sub_number_order or number_order_phone_number","schema":{"type":"string","description":"Record type that the comment relates to i.e number_order, sub_number_order or number_order_phone_number"}},{"name":"filter[comment_record_id]","in":"query","required":true,"description":"ID of the record the comments relate to","schema":{"type":"string","description":"ID of the record the comments relate to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-comment":{"post":{"operationId":"communication_telnyx_create_comment","summary":"Create a comment","description":"POST /comments","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-comment":{"get":{"operationId":"communication_telnyx_retrieve_comment","summary":"Retrieve a comment","description":"GET /comments/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The comment ID.","schema":{"type":"string","description":"The comment ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/mark-comment-read":{"post":{"operationId":"communication_telnyx_mark_comment_read","summary":"Mark a comment as read","description":"PATCH /comments/{id}/read","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The comment ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-conferences":{"get":{"operationId":"communication_telnyx_list_conferences","summary":"List conferences","description":"GET /conferences","tags":["communication"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive","schema":{"type":"string","description":"If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-conference":{"post":{"operationId":"communication_telnyx_create_conference","summary":"Create conference","description":"POST /conferences","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-conference-participants":{"get":{"operationId":"communication_telnyx_list_conference_participants","summary":"List conference participants","description":"GET /conferences/{conference_id}/participants","tags":["communication"],"parameters":[{"name":"conference_id","in":"query","required":true,"description":"Uniquely identifies the conference by id","schema":{"type":"string","description":"Uniquely identifies the conference by id"}},{"name":"filter[muted]","in":"query","required":false,"description":"If present, participants will be filtered to those who are/are not muted","schema":{"type":"boolean","description":"If present, participants will be filtered to those who are/are not muted"}},{"name":"filter[on_hold]","in":"query","required":false,"description":"If present, participants will be filtered to those who are/are not put on hold","schema":{"type":"boolean","description":"If present, participants will be filtered to those who are/are not put on hold"}},{"name":"filter[whispering]","in":"query","required":false,"description":"If present, participants will be filtered to those who are whispering or are not","schema":{"type":"boolean","description":"If present, participants will be filtered to those who are whispering or are not"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-conference":{"get":{"operationId":"communication_telnyx_retrieve_conference","summary":"Retrieve a conference","description":"GET /conferences/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Uniquely identifies the conference by id","schema":{"type":"string","description":"Uniquely identifies the conference by id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-dial-participant-in":{"post":{"operationId":"communication_telnyx_conference_dial_participant_in","summary":"Dial a new participant into a conference","description":"POST /conferences/{id}/actions/dial_participant","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-hold-participants":{"post":{"operationId":"communication_telnyx_conference_hold_participants","summary":"Hold conference participants","description":"POST /conferences/{id}/actions/hold","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-join":{"post":{"operationId":"communication_telnyx_conference_join","summary":"Join a conference","description":"POST /conferences/{id}/actions/join","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-leave":{"post":{"operationId":"communication_telnyx_conference_leave","summary":"Leave a conference","description":"POST /conferences/{id}/actions/leave","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-mute-participants":{"post":{"operationId":"communication_telnyx_conference_mute_participants","summary":"Mute conference participants","description":"POST /conferences/{id}/actions/mute","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-play-audio":{"post":{"operationId":"communication_telnyx_conference_play_audio","summary":"Play audio to conference participants","description":"POST /conferences/{id}/actions/play","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-start-recording":{"post":{"operationId":"communication_telnyx_conference_start_recording","summary":"Conference recording start","description":"POST /conferences/{id}/actions/record_start","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Specifies the conference to record by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-stop-recording":{"post":{"operationId":"communication_telnyx_conference_stop_recording","summary":"Conference recording stop","description":"POST /conferences/{id}/actions/record_stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Specifies the conference to stop the recording for by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-speak-text":{"post":{"operationId":"communication_telnyx_conference_speak_text","summary":"Speak text to conference participants","description":"POST /conferences/{id}/actions/speak","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Specifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-stop-audio":{"post":{"operationId":"communication_telnyx_conference_stop_audio","summary":"Stop audio being played on the conference","description":"POST /conferences/{id}/actions/stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-unhold-participants":{"post":{"operationId":"communication_telnyx_conference_unhold_participants","summary":"Unhold conference participants","description":"POST /conferences/{id}/actions/unhold","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-unmute-participants":{"post":{"operationId":"communication_telnyx_conference_unmute_participants","summary":"Unmute conference participants","description":"POST /conferences/{id}/actions/unmute","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/conference-update":{"post":{"operationId":"communication_telnyx_conference_update","summary":"Update conference participant","description":"POST /conferences/{id}/actions/update","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Uniquely identifies the conference by id or name"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-connections":{"get":{"operationId":"communication_telnyx_list_connections","summary":"List connections","description":"GET /connections","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[connection_name][contains]","in":"query","required":false,"description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…","schema":{"type":"string","description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…"}},{"name":"filter[outbound_voice_profile_id]","in":"query","required":false,"description":"Identifies the associated outbound voice profile.","schema":{"type":"string","description":"Identifies the associated outbound voice profile."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","connection_name","active"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-connection":{"get":{"operationId":"communication_telnyx_retrieve_connection","summary":"Retrieve a connection","description":"GET /connections/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"IP Connection ID","schema":{"type":"string","description":"IP Connection ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-credential-connections":{"get":{"operationId":"communication_telnyx_list_credential_connections","summary":"List credential connections","description":"GET /credential_connections","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[connection_name][contains]","in":"query","required":false,"description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…","schema":{"type":"string","description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…"}},{"name":"filter[outbound.outbound_voice_profile_id]","in":"query","required":false,"description":"Identifies the associated outbound voice profile.","schema":{"type":"string","description":"Identifies the associated outbound voice profile."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","connection_name","active"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-credential-connection":{"post":{"operationId":"communication_telnyx_create_credential_connection","summary":"Create a credential connection","description":"POST /credential_connections","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-credential-connection":{"get":{"operationId":"communication_telnyx_retrieve_credential_connection","summary":"Retrieve a credential connection","description":"GET /credential_connections/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-credential-connection":{"post":{"operationId":"communication_telnyx_update_credential_connection","summary":"Update a credential connection","description":"PATCH /credential_connections/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-credential-connection":{"post":{"operationId":"communication_telnyx_delete_credential_connection","summary":"Delete a credential connection","description":"DELETE /credential_connections/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/detail-records-search":{"get":{"operationId":"communication_telnyx_detail_records_search","summary":"Search detail records","description":"GET /detail_records","tags":["communication"],"parameters":[{"name":"filter[record_type]","in":"query","required":true,"description":"Filter by the given record type","schema":{"type":"string","description":"Filter by the given record type"}},{"name":"filter[date_range]","in":"query","required":false,"description":"Filter by the given user-friendly date range","schema":{"type":"string","description":"Filter by the given user-friendly date range"}},{"name":"filter","in":"query","required":false,"description":"Filter records","schema":{"type":"object","description":"Filter records"}},{"name":"page[number]","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"page[size]","in":"query","required":false,"description":"Page size","schema":{"type":"integer","default":20,"description":"Page size"}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results","schema":{"type":"array","description":"Specifies the sort order for results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-document-links":{"get":{"operationId":"communication_telnyx_list_document_links","summary":"List all document links","description":"GET /document_links","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[document_id]","in":"query","required":false,"description":"Identifies the associated document to filter on.","schema":{"type":"string","description":"Identifies the associated document to filter on."}},{"name":"filter[linked_record_type]","in":"query","required":false,"description":"The `linked_record_type` of the document to filter on.","schema":{"type":"string","description":"The `linked_record_type` of the document to filter on."}},{"name":"filter[linked_resource_id]","in":"query","required":false,"description":"The `linked_resource_id` of the document to filter on.","schema":{"type":"string","description":"The `linked_resource_id` of the document to filter on."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-documents":{"get":{"operationId":"communication_telnyx_list_documents","summary":"List all documents","description":"GET /documents","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-document":{"post":{"operationId":"communication_telnyx_create_document","summary":"Upload a document","description":"POST /documents","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-document":{"get":{"operationId":"communication_telnyx_retrieve_document","summary":"Retrieve a document","description":"GET /documents/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the resource.","schema":{"type":"string","description":"The id of the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-document":{"post":{"operationId":"communication_telnyx_update_document","summary":"Update a document","description":"PATCH /documents/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The id of the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-document":{"post":{"operationId":"communication_telnyx_delete_document","summary":"Delete a document","description":"DELETE /documents/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/download-doc-service-document":{"get":{"operationId":"communication_telnyx_download_doc_service_document","summary":"Download a document","description":"GET /documents/{id}/download","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the resource.","schema":{"type":"string","description":"The id of the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-fax-applications":{"get":{"operationId":"communication_telnyx_list_fax_applications","summary":"List all Fax Applications","description":"GET /fax_applications","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[application_name][contains]","in":"query","required":false,"description":"If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at…","schema":{"type":"string","default":"null","description":"If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at…"}},{"name":"filter[outbound_voice_profile_id]","in":"query","required":false,"description":"Identifies the associated outbound voice profile.","schema":{"type":"string","description":"Identifies the associated outbound voice profile."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","connection_name","active"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-fax-application":{"post":{"operationId":"communication_telnyx_create_fax_application","summary":"Creates a Fax Application","description":"POST /fax_applications","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-fax-application":{"get":{"operationId":"communication_telnyx_get_fax_application","summary":"Retrieve a Fax Application","description":"GET /fax_applications/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-fax-application":{"post":{"operationId":"communication_telnyx_update_fax_application","summary":"Update a Fax Application","description":"PATCH /fax_applications/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-fax-application":{"post":{"operationId":"communication_telnyx_delete_fax_application","summary":"Deletes a Fax Application","description":"DELETE /fax_applications/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-faxes":{"get":{"operationId":"communication_telnyx_list_faxes","summary":"View a list of faxes","description":"GET /faxes","tags":["communication"],"parameters":[{"name":"filter[created_at][gte]","in":"query","required":false,"description":"ISO 8601 date time for filtering faxes created after or on that date","schema":{"type":"string","description":"ISO 8601 date time for filtering faxes created after or on that date"}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"ISO 8601 date time for filtering faxes created after that date","schema":{"type":"string","description":"ISO 8601 date time for filtering faxes created after that date"}},{"name":"filter[created_at][lte]","in":"query","required":false,"description":"ISO 8601 formatted date time for filtering faxes created on or before that date","schema":{"type":"string","description":"ISO 8601 formatted date time for filtering faxes created on or before that date"}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"ISO 8601 formatted date time for filtering faxes created before that date","schema":{"type":"string","description":"ISO 8601 formatted date time for filtering faxes created before that date"}},{"name":"filter[direction][eq]","in":"query","required":false,"description":"The direction, inbound or outbound, for filtering faxes sent from this account","schema":{"type":"string","description":"The direction, inbound or outbound, for filtering faxes sent from this account"}},{"name":"filter[from][eq]","in":"query","required":false,"description":"The phone number, in E.164 format for filtering faxes sent from this number","schema":{"type":"string","description":"The phone number, in E.164 format for filtering faxes sent from this number"}},{"name":"page[size]","in":"query","required":false,"description":"Number of fax resourcxes for the single page returned","schema":{"type":"integer","description":"Number of fax resourcxes for the single page returned"}},{"name":"page[number]","in":"query","required":false,"description":"Number of the page to be retrieved","schema":{"type":"integer","description":"Number of the page to be retrieved"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/send-fax":{"post":{"operationId":"communication_telnyx_send_fax","summary":"Send a fax","description":"POST /faxes","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/view-fax":{"get":{"operationId":"communication_telnyx_view_fax","summary":"View a fax","description":"GET /faxes/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The unique identifier of a fax.","schema":{"type":"string","description":"The unique identifier of a fax."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-fax":{"post":{"operationId":"communication_telnyx_delete_fax","summary":"Delete a fax","description":"DELETE /faxes/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of a fax."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/refresh-fax":{"post":{"operationId":"communication_telnyx_refresh_fax","summary":"Refresh a fax","description":"POST /faxes/{id}/actions/refresh","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The unique identifier of a fax."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-fqdn-connections":{"get":{"operationId":"communication_telnyx_list_fqdn_connections","summary":"List FQDN connections","description":"GET /fqdn_connections","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[connection_name][contains]","in":"query","required":false,"description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…","schema":{"type":"string","description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…"}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","connection_name","active"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-fqdn-connection":{"post":{"operationId":"communication_telnyx_create_fqdn_connection","summary":"Create an FQDN connection","description":"POST /fqdn_connections","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-fqdn-connection":{"get":{"operationId":"communication_telnyx_retrieve_fqdn_connection","summary":"Retrieve an FQDN connection","description":"GET /fqdn_connections/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"FQDN Connection ID","schema":{"type":"string","description":"FQDN Connection ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-fqdn-connection":{"post":{"operationId":"communication_telnyx_update_fqdn_connection","summary":"Update an FQDN connection","description":"PATCH /fqdn_connections/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"FQDN Connection ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-fqdn-connection":{"post":{"operationId":"communication_telnyx_delete_fqdn_connection","summary":"Delete an FQDN connection","description":"DELETE /fqdn_connections/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"FQDN Connection ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-fqdns":{"get":{"operationId":"communication_telnyx_list_fqdns","summary":"List FQDNs","description":"GET /fqdns","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[connection_id]","in":"query","required":false,"description":"ID of the FQDN connection to which the FQDN belongs.","schema":{"type":"string","description":"ID of the FQDN connection to which the FQDN belongs."}},{"name":"filter[fqdn]","in":"query","required":false,"description":"FQDN represented by the resource.","schema":{"type":"string","description":"FQDN represented by the resource."}},{"name":"filter[port]","in":"query","required":false,"description":"Port to use when connecting to the FQDN.","schema":{"type":"integer","description":"Port to use when connecting to the FQDN."}},{"name":"filter[dns_record_type]","in":"query","required":false,"description":"DNS record type used by the FQDN.","schema":{"type":"string","description":"DNS record type used by the FQDN."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-fqdn":{"post":{"operationId":"communication_telnyx_create_fqdn","summary":"Create an FQDN","description":"POST /fqdns","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-fqdn":{"get":{"operationId":"communication_telnyx_retrieve_fqdn","summary":"Retrieve an FQDN","description":"GET /fqdns/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-fqdn":{"post":{"operationId":"communication_telnyx_update_fqdn","summary":"Update an FQDN","description":"PATCH /fqdns/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-fqdn":{"post":{"operationId":"communication_telnyx_delete_fqdn","summary":"Delete an FQDN","description":"DELETE /fqdns/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-inventory-coverage-request":{"get":{"operationId":"communication_telnyx_create_inventory_coverage_request","summary":"Create an inventory coverage request","description":"GET /inventory_coverage","tags":["communication"],"parameters":[{"name":"filter[npa]","in":"query","required":false,"description":"Filter by npa","schema":{"type":"integer","description":"Filter by npa"},"example":318},{"name":"filter[nxx]","in":"query","required":false,"description":"Filter by nxx","schema":{"type":"integer","description":"Filter by nxx"},"example":202},{"name":"filter[administrative_area]","in":"query","required":false,"description":"Filter by administrative area","schema":{"type":"string","description":"Filter by administrative area"},"example":"LA"},{"name":"filter[number_type]","in":"query","required":false,"description":"Filter by number type","schema":{"type":"string","enum":["did","toll-free"],"description":"Filter by number type"},"example":"did"},{"name":"filter[phone_number_type]","in":"query","required":false,"description":"Filter by phone number type","schema":{"type":"string","enum":["local","toll_free","national","mobile","landline","shared_cost"],"description":"Filter by phone number type"},"example":"local"},{"name":"filter[country_code]","in":"query","required":false,"description":"Filter by country. Defaults to US","schema":{"type":"string","enum":["US","CA","GB"],"description":"Filter by country. Defaults to US"},"example":"US"},{"name":"filter[count]","in":"query","required":false,"description":"Include count in the result","schema":{"type":"boolean","description":"Include count in the result"},"example":"true"},{"name":"filter[groupBy]","in":"query","required":true,"description":"Filter to group results","schema":{"type":"string","enum":["rate_center","locality","npa","national_destination_code","nxx"],"description":"Filter to group results"},"example":"nxx"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-ip-connections":{"get":{"operationId":"communication_telnyx_list_ip_connections","summary":"List Ip connections","description":"GET /ip_connections","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[connection_name][contains]","in":"query","required":false,"description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…","schema":{"type":"string","description":"If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at…"}},{"name":"filter[outbound.outbound_voice_profile_id]","in":"query","required":false,"description":"Identifies the associated outbound voice profile.","schema":{"type":"string","description":"Identifies the associated outbound voice profile."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","connection_name","active"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-ip-connection":{"post":{"operationId":"communication_telnyx_create_ip_connection","summary":"Create an Ip connection","description":"POST /ip_connections","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-ip-connection":{"get":{"operationId":"communication_telnyx_retrieve_ip_connection","summary":"Retrieve an Ip connection","description":"GET /ip_connections/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"IP Connection ID","schema":{"type":"string","description":"IP Connection ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-ip-connection":{"post":{"operationId":"communication_telnyx_update_ip_connection","summary":"Update an Ip connection","description":"PATCH /ip_connections/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the type of resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-ip-connection":{"post":{"operationId":"communication_telnyx_delete_ip_connection","summary":"Delete an Ip connection","description":"DELETE /ip_connections/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the type of resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-ips":{"get":{"operationId":"communication_telnyx_list_ips","summary":"List Ips","description":"GET /ips","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[connection_id]","in":"query","required":false,"description":"ID of the IP Connection to which this IP should be attached.","schema":{"type":"string","description":"ID of the IP Connection to which this IP should be attached."}},{"name":"filter[ip_address]","in":"query","required":false,"description":"IP adddress represented by this resource.","schema":{"type":"string","description":"IP adddress represented by this resource."}},{"name":"filter[port]","in":"query","required":false,"description":"Port to use when connecting to this IP.","schema":{"type":"integer","description":"Port to use when connecting to this IP."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-ip":{"post":{"operationId":"communication_telnyx_create_ip","summary":"Create an Ip","description":"POST /ips","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-ip":{"get":{"operationId":"communication_telnyx_retrieve_ip","summary":"Retrieve an Ip","description":"GET /ips/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the type of resource.","schema":{"type":"string","description":"Identifies the type of resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-ip":{"post":{"operationId":"communication_telnyx_update_ip","summary":"Update an Ip","description":"PATCH /ips/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the type of resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-ip":{"post":{"operationId":"communication_telnyx_delete_ip","summary":"Delete an Ip","description":"DELETE /ips/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the type of resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-ledger-billing-group-report":{"post":{"operationId":"communication_telnyx_create_ledger_billing_group_report","summary":"Create a ledger billing group report","description":"POST /ledger_billing_group_reports","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-ledger-billing-group-report":{"get":{"operationId":"communication_telnyx_retrieve_ledger_billing_group_report","summary":"Retrieve a ledger billing group report","description":"GET /ledger_billing_group_reports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the ledger billing group report","schema":{"type":"string","description":"The id of the ledger billing group report"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-managed-accounts":{"get":{"operationId":"communication_telnyx_list_managed_accounts","summary":"Lists accounts managed by the current user.","description":"GET /managed_accounts","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[email][contains]","in":"query","required":false,"description":"If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.","schema":{"type":"string","default":"null","description":"If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters."}},{"name":"filter[email][eq]","in":"query","required":false,"description":"If present, only returns results with the email matching exactly the value given.","schema":{"type":"string","default":"null","description":"If present, only returns results with the email matching exactly the value given."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","email"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-managed-account":{"post":{"operationId":"communication_telnyx_create_managed_account","summary":"Create a new managed account.","description":"POST /managed_accounts","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-managed-account":{"get":{"operationId":"communication_telnyx_retrieve_managed_account","summary":"Retrieve a managed account","description":"GET /managed_accounts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Managed Account User ID","schema":{"type":"string","description":"Managed Account User ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/disable-managed-account":{"post":{"operationId":"communication_telnyx_disable_managed_account","summary":"Disables a managed account","description":"POST /managed_accounts/{id}/actions/disable","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Managed Account User ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/enable-managed-account":{"post":{"operationId":"communication_telnyx_enable_managed_account","summary":"Enables a managed account","description":"POST /managed_accounts/{id}/actions/enable","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Managed Account User ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-media":{"get":{"operationId":"communication_telnyx_list_media","summary":"List uploaded media","description":"GET /media","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-media":{"post":{"operationId":"communication_telnyx_create_media","summary":"Upload media","description":"POST /media","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-media":{"get":{"operationId":"communication_telnyx_get_media","summary":"Retrieve stored media","description":"GET /media/{media_name}","tags":["communication"],"parameters":[{"name":"media_name","in":"query","required":true,"description":"Uniquely identifies a media resource.","schema":{"type":"string","description":"Uniquely identifies a media resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-media":{"post":{"operationId":"communication_telnyx_update_media","summary":"Update stored media","description":"PUT /media/{media_name}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["media_name","body"],"properties":{"media_name":{"type":"string","description":"Uniquely identifies a media resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-media":{"post":{"operationId":"communication_telnyx_delete_media","summary":"Deletes stored media","description":"DELETE /media/{media_name}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["media_name"],"properties":{"media_name":{"type":"string","description":"Uniquely identifies a media resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/download-media":{"get":{"operationId":"communication_telnyx_download_media","summary":"Download stored media","description":"GET /media/{media_name}/download","tags":["communication"],"parameters":[{"name":"media_name","in":"query","required":true,"description":"Uniquely identifies a media resource.","schema":{"type":"string","description":"Uniquely identifies a media resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-paginated-mdrs":{"get":{"operationId":"communication_telnyx_get_paginated_mdrs","summary":"Fetch messaging detail records.","description":"GET /message_detail_records","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":true,"description":"Start date","schema":{"type":"string","description":"Start date"}},{"name":"end_date","in":"query","required":true,"description":"End date","schema":{"type":"string","description":"End date"}},{"name":"id","in":"query","required":false,"description":"Message uuid","schema":{"type":"string","description":"Message uuid"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["INBOUND","OUTBOUND"]}},{"name":"outbound_profile_id","in":"query","required":false,"description":"Configured profile id. New profiles can be created and configured on Telnyx portal","schema":{"type":"string","description":"Configured profile id. New profiles can be created and configured on Telnyx portal"}},{"name":"cld","in":"query","required":false,"description":"Destination number","schema":{"type":"string","description":"Destination number"}},{"name":"cli","in":"query","required":false,"description":"Origination number","schema":{"type":"string","description":"Origination number"}},{"name":"status","in":"query","required":false,"description":"Message status","schema":{"type":"string","enum":["GW_TIMEOUT","DELIVERED","DLR_UNCONFIRMED","DLR_TIMEOUT","RECEIVED","GW_REJECT","FAILED"],"description":"Message status"}},{"name":"message_type","in":"query","required":false,"description":"type of the message","schema":{"type":"string","enum":["audio","contacts","document","hsm","image","location","template","text","video","voice","unknown"],"default":"text","description":"type of the message"}},{"name":"country_iso","in":"query","required":false,"description":"Destination number ISO country code","schema":{"type":"string","description":"Destination number ISO country code"}},{"name":"error","in":"query","required":false,"description":"Reported error code","schema":{"type":"string","description":"Reported error code"}},{"name":"normalized_carrier","in":"query","required":false,"description":"Carrier","schema":{"type":"string","description":"Carrier"}},{"name":"tag","in":"query","required":false,"description":"Specified tag","schema":{"type":"string","description":"Specified tag"}},{"name":"mcc","in":"query","required":false,"description":"Mobile country code","schema":{"type":"string","description":"Mobile country code"}},{"name":"mnc","in":"query","required":false,"description":"Mobile network code","schema":{"type":"string","description":"Mobile network code"}},{"name":"product","in":"query","required":false,"description":"Used product","schema":{"type":"string","enum":["LONG_CODE","SHORT_CODE","SHORT_CODE_FTEU","TOLL_FREE","ALPHANUMERIC_ID","RCS"],"description":"Used product"}},{"name":"page[number]","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"page[size]","in":"query","required":false,"description":"Size of the page","schema":{"type":"integer","default":20,"description":"Size of the page"}},{"name":"sort","in":"query","required":false,"description":"Field used to order the data. If no field is specified, default value is 'created_at'","schema":{"type":"array","default":"created_at","description":"Field used to order the data. If no field is specified, default value is 'created_at'"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-mdr-message-body":{"get":{"operationId":"communication_telnyx_get_mdr_message_body","summary":"Fetch message body by id.","description":"GET /message_detail_records/{id}/message_body","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Message unique identifier","schema":{"type":"string","description":"Message unique identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-message":{"post":{"operationId":"communication_telnyx_create_message","summary":"Send a message","description":"POST /messages","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-long-code-message":{"post":{"operationId":"communication_telnyx_create_long_code_message","summary":"Send a long code message","description":"POST /messages/long_code","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-number-pool-message":{"post":{"operationId":"communication_telnyx_create_number_pool_message","summary":"Send a message using number pool","description":"POST /messages/number_pool","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-short-code-message":{"post":{"operationId":"communication_telnyx_create_short_code_message","summary":"Send a short code message","description":"POST /messages/short_code","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-message":{"get":{"operationId":"communication_telnyx_retrieve_message","summary":"Retrieve a message","description":"GET /messages/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the message","schema":{"type":"string","description":"The id of the message"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-messaging-hosted-number-order":{"get":{"operationId":"communication_telnyx_list_messaging_hosted_number_order","summary":"List messaging hosted number orders","description":"GET /messaging_hosted_number_orders","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-messaging-hosted-number-order":{"post":{"operationId":"communication_telnyx_create_messaging_hosted_number_order","summary":"Create a messaging hosted number order","description":"POST /messaging_hosted_number_orders","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-messaging-hosted-number-order":{"get":{"operationId":"communication_telnyx_retrieve_messaging_hosted_number_order","summary":"Retrieve a messaging hosted number order","description":"GET /messaging_hosted_number_orders/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the type of resource.","schema":{"type":"string","description":"Identifies the type of resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/upload-file-messaging-hosted-number-order":{"post":{"operationId":"communication_telnyx_upload_file_messaging_hosted_number_order","summary":"Upload file required for a messaging hosted number order","description":"POST /messaging_hosted_number_orders/{id}/actions/file_upload","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the type of resource."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-messaging-hosted-number":{"post":{"operationId":"communication_telnyx_delete_messaging_hosted_number","summary":"Delete a messaging hosted number","description":"DELETE /messaging_hosted_numbers/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the type of resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-messaging-profile-metrics":{"get":{"operationId":"communication_telnyx_list_messaging_profile_metrics","summary":"List messaging profile metrics","description":"GET /messaging_profile_metrics","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"id","in":"query","required":false,"description":"The id of the messaging profile(s) to retrieve","schema":{"type":"string","description":"The id of the messaging profile(s) to retrieve"}},{"name":"time_frame","in":"query","required":false,"description":"The timeframe for which you'd like to retrieve metrics.","schema":{"type":"string","enum":["1h","3h","24h","3d","7d","30d"],"default":"24h","description":"The timeframe for which you'd like to retrieve metrics."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-messaging-profiles":{"get":{"operationId":"communication_telnyx_list_messaging_profiles","summary":"List messaging profiles","description":"GET /messaging_profiles","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-messaging-profile":{"post":{"operationId":"communication_telnyx_create_messaging_profile","summary":"Create a messaging profile","description":"POST /messaging_profiles","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-messaging-profile":{"get":{"operationId":"communication_telnyx_retrieve_messaging_profile","summary":"Retrieve a messaging profile","description":"GET /messaging_profiles/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the messaging profile to retrieve","schema":{"type":"string","description":"The id of the messaging profile to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-messaging-profile":{"post":{"operationId":"communication_telnyx_update_messaging_profile","summary":"Update a messaging profile","description":"PATCH /messaging_profiles/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The id of the messaging profile to retrieve"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-messaging-profile":{"post":{"operationId":"communication_telnyx_delete_messaging_profile","summary":"Delete a messaging profile","description":"DELETE /messaging_profiles/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the messaging profile to retrieve"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-messaging-profile-detailed-metrics":{"get":{"operationId":"communication_telnyx_retrieve_messaging_profile_detailed_metrics","summary":"Retrieve messaging profile metrics","description":"GET /messaging_profiles/{id}/metrics","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the messaging profile to retrieve","schema":{"type":"string","description":"The id of the messaging profile to retrieve"}},{"name":"time_frame","in":"query","required":false,"description":"The timeframe for which you'd like to retrieve metrics.","schema":{"type":"string","enum":["1h","3h","24h","3d","7d","30d"],"default":"24h","description":"The timeframe for which you'd like to retrieve metrics."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-messaging-profile-phone-numbers":{"get":{"operationId":"communication_telnyx_list_messaging_profile_phone_numbers","summary":"List phone numbers associated with a messaging profile","description":"GET /messaging_profiles/{id}/phone_numbers","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"id","in":"query","required":true,"description":"The id of the messaging profile to retrieve","schema":{"type":"string","description":"The id of the messaging profile to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-messaging-profile-short-codes":{"get":{"operationId":"communication_telnyx_list_messaging_profile_short_codes","summary":"List short codes associated with a messaging profile","description":"GET /messaging_profiles/{id}/short_codes","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"id","in":"query","required":true,"description":"The id of the messaging profile to retrieve","schema":{"type":"string","description":"The id of the messaging profile to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-messaging-url-domains":{"get":{"operationId":"communication_telnyx_list_messaging_url_domains","summary":"List messaging URL domains","description":"GET /messaging_url_domains","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/mobile-operator-networks-get":{"get":{"operationId":"communication_telnyx_mobile_operator_networks_get","summary":"List mobile operator networks","description":"GET /mobile_operator_networks","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[name][starts_with]","in":"query","required":false,"description":"Filter by name starting with.","schema":{"type":"string","description":"Filter by name starting with."}},{"name":"filter[name][contains]","in":"query","required":false,"description":"Filter by name containing match.","schema":{"type":"string","description":"Filter by name containing match."}},{"name":"filter[name][ends_with]","in":"query","required":false,"description":"Filter by name ending with.","schema":{"type":"string","description":"Filter by name ending with."}},{"name":"filter[country_code]","in":"query","required":false,"description":"Filter by exact country_code.","schema":{"type":"string","description":"Filter by exact country_code."}},{"name":"filter[mcc]","in":"query","required":false,"description":"Filter by exact MCC.","schema":{"type":"string","description":"Filter by exact MCC."}},{"name":"filter[mnc]","in":"query","required":false,"description":"Filter by exact MNC.","schema":{"type":"string","description":"Filter by exact MNC."}},{"name":"filter[tadig]","in":"query","required":false,"description":"Filter by exact TADIG.","schema":{"type":"string","description":"Filter by exact TADIG."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-notification-channels":{"get":{"operationId":"communication_telnyx_list_notification_channels","summary":"List notification channels","description":"GET /notification_channels","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[channel_type_id][eq]","in":"query","required":false,"description":"Filter by the id of a channel type","schema":{"type":"string","enum":["webhook","sms","email","voice"],"description":"Filter by the id of a channel type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-notification-channels":{"post":{"operationId":"communication_telnyx_create_notification_channels","summary":"Create a notification channel","description":"POST /notification_channels","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-notification-channel":{"get":{"operationId":"communication_telnyx_retrieve_notification_channel","summary":"Retrieve a notification channel","description":"GET /notification_channels/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the resource.","schema":{"type":"string","description":"The id of the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-notification-channel":{"post":{"operationId":"communication_telnyx_update_notification_channel","summary":"Update a notification channel","description":"PATCH /notification_channels/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The id of the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-notification-channel":{"post":{"operationId":"communication_telnyx_delete_notification_channel","summary":"Delete a notification channel","description":"DELETE /notification_channels/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-notifications-events-conditions":{"get":{"operationId":"communication_telnyx_find_notifications_events_conditions","summary":"List all Notifications Events Conditions","description":"GET /notification_event_conditions","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[associated_record_type][eq]","in":"query","required":false,"description":"Filter by the associated record type","schema":{"type":"string","enum":["account","phone_number"],"description":"Filter by the associated record type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-notifications-events":{"get":{"operationId":"communication_telnyx_find_notifications_events","summary":"List all Notifications Events","description":"GET /notification_events","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-notifications-profiles":{"get":{"operationId":"communication_telnyx_find_notifications_profiles","summary":"List all Notifications Profiles","description":"GET /notification_profiles","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-notification-profile":{"post":{"operationId":"communication_telnyx_create_notification_profile","summary":"Create a notification profile","description":"POST /notification_profiles","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-notification-profile":{"get":{"operationId":"communication_telnyx_retrieve_notification_profile","summary":"Retrieve a notification profile","description":"GET /notification_profiles/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the resource.","schema":{"type":"string","description":"The id of the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-notification-profile":{"post":{"operationId":"communication_telnyx_update_notification_profile","summary":"Update a notification profile","description":"PATCH /notification_profiles/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The id of the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-notification-profile":{"post":{"operationId":"communication_telnyx_delete_notification_profile","summary":"Delete a notification profile","description":"DELETE /notification_profiles/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-notification-settings":{"get":{"operationId":"communication_telnyx_list_notification_settings","summary":"List notification settings","description":"GET /notification_settings","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[notification_profile_id][eq]","in":"query","required":false,"description":"Filter by the id of a notification profile","schema":{"type":"string","description":"Filter by the id of a notification profile"}},{"name":"filter[notification_channel][eq]","in":"query","required":false,"description":"Filter by the id of a notification channel","schema":{"type":"string","description":"Filter by the id of a notification channel"}},{"name":"filter[notification_event_condition_id][eq]","in":"query","required":false,"description":"Filter by the id of a notification channel","schema":{"type":"string","description":"Filter by the id of a notification channel"}},{"name":"filter[associated_record_type][eq]","in":"query","required":false,"description":"Filter by the associated record type","schema":{"type":"string","enum":["account","phone_number"],"description":"Filter by the associated record type"}},{"name":"filter[status][eq]","in":"query","required":false,"description":"The status of a notification setting","schema":{"type":"string","enum":["enabled","enable-received","enable-pending","enable-submtited","delete-received","delete-pending","delete-submitted","deleted"],"description":"The status of a notification setting"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-notification-setting":{"post":{"operationId":"communication_telnyx_create_notification_setting","summary":"Add a Notification Setting","description":"POST /notification_settings","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-notification-setting":{"get":{"operationId":"communication_telnyx_retrieve_notification_setting","summary":"Retrieve a notification setting","description":"GET /notification_settings/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the resource.","schema":{"type":"string","description":"The id of the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-notification-setting":{"post":{"operationId":"communication_telnyx_delete_notification_setting","summary":"Delete a notification setting","description":"DELETE /notification_settings/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The id of the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-number-block-orders":{"get":{"operationId":"communication_telnyx_list_number_block_orders","summary":"List number block orders","description":"GET /number_block_orders","tags":["communication"],"parameters":[{"name":"filter[status]","in":"query","required":false,"description":"Filter number block orders by status.","schema":{"type":"string","description":"Filter number block orders by status."}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter number block orders later than this value.","schema":{"type":"string","description":"Filter number block orders later than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter number block orders earlier than this value.","schema":{"type":"string","description":"Filter number block orders earlier than this value."}},{"name":"filter[phone_numbers.starting_number]","in":"query","required":false,"description":"Filter number block orders having these phone numbers.","schema":{"type":"string","description":"Filter number block orders having these phone numbers."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-number-block-order":{"post":{"operationId":"communication_telnyx_create_number_block_order","summary":"Create a number block order","description":"POST /number_block_orders","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-number-block-order":{"get":{"operationId":"communication_telnyx_retrieve_number_block_order","summary":"Retrieve a number block order","description":"GET /number_block_orders/{number_block_order_id}","tags":["communication"],"parameters":[{"name":"number_block_order_id","in":"query","required":true,"description":"The number block order ID.","schema":{"type":"string","description":"The number block order ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/number-lookup":{"get":{"operationId":"communication_telnyx_number_lookup","summary":"Lookup phone number data","description":"GET /number_lookup/{phone_number}","tags":["communication"],"parameters":[{"name":"phone_number","in":"query","required":true,"description":"The phone number to be looked up","schema":{"type":"string","description":"The phone number to be looked up"}},{"name":"type","in":"query","required":false,"description":"Specifies the type of number lookup to be performed","schema":{"type":"string","enum":["carrier","caller-name"],"description":"Specifies the type of number lookup to be performed"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-number-order-documents":{"get":{"operationId":"communication_telnyx_list_number_order_documents","summary":"List number order documents","description":"GET /number_order_documents","tags":["communication"],"parameters":[{"name":"filter[requirement_id]","in":"query","required":false,"description":"Filter number order documents by `requirement_id`.","schema":{"type":"string","description":"Filter number order documents by `requirement_id`."}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter number order documents after this datetime.","schema":{"type":"string","description":"Filter number order documents after this datetime."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter number order documents from before this datetime.","schema":{"type":"string","description":"Filter number order documents from before this datetime."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-number-order-document":{"post":{"operationId":"communication_telnyx_create_number_order_document","summary":"Create a number order document","description":"POST /number_order_documents","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-number-order-document":{"get":{"operationId":"communication_telnyx_retrieve_number_order_document","summary":"Retrieve a number order document","description":"GET /number_order_documents/{number_order_document_id}","tags":["communication"],"parameters":[{"name":"number_order_document_id","in":"query","required":true,"description":"The number order document ID.","schema":{"type":"string","description":"The number order document ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-number-order-document":{"post":{"operationId":"communication_telnyx_update_number_order_document","summary":"Update a number order document","description":"PATCH /number_order_documents/{number_order_document_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number_order_document_id","body"],"properties":{"number_order_document_id":{"type":"string","description":"The number order document ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-number-order-phone-numbers":{"get":{"operationId":"communication_telnyx_retrieve_number_order_phone_numbers","summary":"Retrieve a list of phone numbers associated to orders","description":"GET /number_order_phone_numbers","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-number-order-phone-number":{"get":{"operationId":"communication_telnyx_retrieve_number_order_phone_number","summary":"Retrieve a number order phone number.","description":"GET /number_order_phone_numbers/{number_order_phone_number_id}","tags":["communication"],"parameters":[{"name":"number_order_phone_number_id","in":"query","required":true,"description":"The number order phone number ID.","schema":{"type":"string","description":"The number order phone number ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-number-order-phone-number":{"post":{"operationId":"communication_telnyx_update_number_order_phone_number","summary":"Update a number order phone number.","description":"PATCH /number_order_phone_numbers/{number_order_phone_number_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number_order_phone_number_id","body"],"properties":{"number_order_phone_number_id":{"type":"string","description":"The number order phone number ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-number-orders":{"get":{"operationId":"communication_telnyx_list_number_orders","summary":"List number orders","description":"GET /number_orders","tags":["communication"],"parameters":[{"name":"filter[status]","in":"query","required":false,"description":"Filter number orders by status.","schema":{"type":"string","description":"Filter number orders by status."}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter number orders later than this value.","schema":{"type":"string","description":"Filter number orders later than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter number orders earlier than this value.","schema":{"type":"string","description":"Filter number orders earlier than this value."}},{"name":"filter[phone_numbers_count]","in":"query","required":false,"description":"Filter number order with this amount of numbers","schema":{"type":"string","description":"Filter number order with this amount of numbers"}},{"name":"filter[customer_reference]","in":"query","required":false,"description":"Filter number orders via the customer reference set.","schema":{"type":"string","description":"Filter number orders via the customer reference set."}},{"name":"filter[requirements_met]","in":"query","required":false,"description":"Filter number orders by requirements met.","schema":{"type":"boolean","description":"Filter number orders by requirements met."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-number-order":{"post":{"operationId":"communication_telnyx_create_number_order","summary":"Create a number order","description":"POST /number_orders","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-number-order":{"get":{"operationId":"communication_telnyx_retrieve_number_order","summary":"Retrieve a number order","description":"GET /number_orders/{number_order_id}","tags":["communication"],"parameters":[{"name":"number_order_id","in":"query","required":true,"description":"The number order ID.","schema":{"type":"string","description":"The number order ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-number-order":{"post":{"operationId":"communication_telnyx_update_number_order","summary":"Update a number order","description":"PATCH /number_orders/{number_order_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number_order_id","body"],"properties":{"number_order_id":{"type":"string","description":"The number order ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-number-reservations":{"get":{"operationId":"communication_telnyx_list_number_reservations","summary":"List number reservations","description":"GET /number_reservations","tags":["communication"],"parameters":[{"name":"filter[status]","in":"query","required":false,"description":"Filter number reservations by status.","schema":{"type":"string","description":"Filter number reservations by status."}},{"name":"filter[created_at][gt]","in":"query","required":false,"description":"Filter number reservations later than this value.","schema":{"type":"string","description":"Filter number reservations later than this value."}},{"name":"filter[created_at][lt]","in":"query","required":false,"description":"Filter number reservations earlier than this value.","schema":{"type":"string","description":"Filter number reservations earlier than this value."}},{"name":"filter[phone_numbers.phone_number]","in":"query","required":false,"description":"Filter number reservations having these phone numbers.","schema":{"type":"string","description":"Filter number reservations having these phone numbers."}},{"name":"filter[customer_reference]","in":"query","required":false,"description":"Filter number reservations via the customer reference set.","schema":{"type":"string","description":"Filter number reservations via the customer reference set."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-number-reservation":{"post":{"operationId":"communication_telnyx_create_number_reservation","summary":"Create a number reservation","description":"POST /number_reservations","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-number-reservation":{"get":{"operationId":"communication_telnyx_retrieve_number_reservation","summary":"Retrieve a number reservation","description":"GET /number_reservations/{number_reservation_id}","tags":["communication"],"parameters":[{"name":"number_reservation_id","in":"query","required":true,"description":"The number reservation ID.","schema":{"type":"string","description":"The number reservation ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/extend-number-reservation-expiry-time":{"post":{"operationId":"communication_telnyx_extend_number_reservation_expiry_time","summary":"Extend a number reservation","description":"POST /number_reservations/{number_reservation_id}/actions/extend","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number_reservation_id"],"properties":{"number_reservation_id":{"type":"string","description":"The number reservation ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/otaupdates-list":{"get":{"operationId":"communication_telnyx_otaupdates_list","summary":"List OTA updates","description":"GET /ota_updates","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[status]","in":"query","required":false,"description":"Filter by a specific status of the resource's lifecycle.","schema":{"type":"string","enum":["in-progress","completed","failed"],"description":"Filter by a specific status of the resource's lifecycle."}},{"name":"filter[sim_card_id]","in":"query","required":false,"description":"The SIM card identification UUID.","schema":{"type":"string","description":"The SIM card identification UUID."}},{"name":"filter[type]","in":"query","required":false,"description":"Filter by type.","schema":{"type":"string","enum":["sim_card_network_preferences"],"description":"Filter by type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/otaupdate-get":{"get":{"operationId":"communication_telnyx_otaupdate_get","summary":"Get OTA update","description":"GET /ota_updates/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-outbound-voice-profiles":{"get":{"operationId":"communication_telnyx_list_outbound_voice_profiles","summary":"Get all outbound voice profiles","description":"GET /outbound_voice_profiles","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[name][contains]","in":"query","required":false,"description":"Optional filter on outbound voice profile name.","schema":{"type":"string","description":"Optional filter on outbound voice profile name."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["enabled","-enabled","created_at","-created_at","name","-name","service_plan","-service_plan","traffic_type","-traffic_type","usage_payment_method","-usage_payment_method"],"default":"-created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-outbound-voice-profile":{"post":{"operationId":"communication_telnyx_create_outbound_voice_profile","summary":"Create an outbound voice profile","description":"POST /outbound_voice_profiles","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-outbound-voice-profile":{"get":{"operationId":"communication_telnyx_retrieve_outbound_voice_profile","summary":"Retrieve an outbound voice profile","description":"GET /outbound_voice_profiles/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-outbound-voice-profile":{"post":{"operationId":"communication_telnyx_update_outbound_voice_profile","summary":"Updates an existing outbound voice profile.","description":"PATCH /outbound_voice_profiles/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-outbound-voice-profile":{"post":{"operationId":"communication_telnyx_delete_outbound_voice_profile","summary":"Delete an outbound voice profile","description":"DELETE /outbound_voice_profiles/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-phone-number-blocks-jobs":{"get":{"operationId":"communication_telnyx_list_phone_number_blocks_jobs","summary":"Lists the phone number blocks jobs","description":"GET /phone_number_blocks/jobs","tags":["communication"],"parameters":[{"name":"filter[type]","in":"query","required":false,"description":"Filter the phone number blocks jobs by type.","schema":{"type":"string","enum":["delete_phone_number_block"],"description":"Filter the phone number blocks jobs by type."}},{"name":"filter[status]","in":"query","required":false,"description":"Filter the phone number blocks jobs by status.","schema":{"type":"string","enum":["pending","in_progress","completed","failed"],"description":"Filter the phone number blocks jobs by status."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order.","schema":{"type":"string","enum":["created_at"],"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-phone-number-blocks-job-delete-phone-number-block":{"post":{"operationId":"communication_telnyx_create_phone_number_blocks_job_delete_phone_number_block","summary":"Deletes all numbers associated with a phone number block","description":"POST /phone_number_blocks/jobs/delete_phone_number_block","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-phone-number-blocks-job":{"get":{"operationId":"communication_telnyx_retrieve_phone_number_blocks_job","summary":"Retrieves a phone number blocks job","description":"GET /phone_number_blocks/jobs/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the Phone Number Blocks Job.","schema":{"type":"string","description":"Identifies the Phone Number Blocks Job."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-phone-numbers":{"get":{"operationId":"communication_telnyx_list_phone_numbers","summary":"List phone numbers","description":"GET /phone_numbers","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[tag]","in":"query","required":false,"description":"Filter by phone number tags.","schema":{"type":"string","description":"Filter by phone number tags."}},{"name":"filter[phone_number]","in":"query","required":false,"description":"Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.","schema":{"type":"string","description":"Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned."}},{"name":"filter[status]","in":"query","required":false,"description":"Filter by phone number status.","schema":{"type":"string","enum":["purchase_pending","purchase_failed","port_pending","active","deleted","port_failed","emergency_only","ported_out","port_out_pending"],"description":"Filter by phone number status."}},{"name":"filter[voice.connection_name][contains]","in":"query","required":false,"description":"Filter contains connection name. Requires at least three characters.","schema":{"type":"string","description":"Filter contains connection name. Requires at least three characters."}},{"name":"filter[voice.connection_name][starts_with]","in":"query","required":false,"description":"Filter starts with connection name. Requires at least three characters.","schema":{"type":"string","description":"Filter starts with connection name. Requires at least three characters."}},{"name":"filter[voice.connection_name][ends_with]","in":"query","required":false,"description":"Filter ends with connection name. Requires at least three characters.","schema":{"type":"string","description":"Filter ends with connection name. Requires at least three characters."}},{"name":"filter[voice.connection_name][eq]","in":"query","required":false,"description":"Filter by connection name.","schema":{"type":"string","description":"Filter by connection name."}},{"name":"filter[usage_payment_method]","in":"query","required":false,"description":"Filter by usage_payment_method.","schema":{"type":"string","enum":["pay-per-minute","channel"],"description":"Filter by usage_payment_method."}},{"name":"filter[billing_group_id]","in":"query","required":false,"description":"Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them,…","schema":{"type":"string","description":"Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them,…"}},{"name":"filter[emergency_address_id]","in":"query","required":false,"description":"Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated…","schema":{"type":"string","description":"Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated…"}},{"name":"filter[customer_reference]","in":"query","required":false,"description":"Filter numbers via the customer_reference set.","schema":{"type":"string","description":"Filter numbers via the customer_reference set."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order.","schema":{"type":"string","enum":["purchased_at","phone_number","connection_name","usage_payment_method"],"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-csv-downloads":{"get":{"operationId":"communication_telnyx_list_csv_downloads","summary":"List CSV downloads","description":"GET /phone_numbers/csv_downloads","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-csv-download":{"post":{"operationId":"communication_telnyx_create_csv_download","summary":"Create a CSV download","description":"POST /phone_numbers/csv_downloads","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-csv-download":{"get":{"operationId":"communication_telnyx_retrieve_csv_download","summary":"Retrieve a CSV download","description":"GET /phone_numbers/csv_downloads/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the CSV download.","schema":{"type":"string","description":"Identifies the CSV download."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-outbound-channels":{"get":{"operationId":"communication_telnyx_list_outbound_channels","summary":"Retrieve your inbound channels","description":"GET /phone_numbers/inbound_channels","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-outbound-channels":{"post":{"operationId":"communication_telnyx_update_outbound_channels","summary":"Update inbound channels","description":"PATCH /phone_numbers/inbound_channels","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-phone-numbers-jobs":{"get":{"operationId":"communication_telnyx_list_phone_numbers_jobs","summary":"Lists the phone numbers jobs","description":"GET /phone_numbers/jobs","tags":["communication"],"parameters":[{"name":"filter[type]","in":"query","required":false,"description":"Filter the phone number jobs by type.","schema":{"type":"string","enum":["update_emergency_settings","delete_phone_numbers","update_phone_numbers"],"description":"Filter the phone number jobs by type."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order.","schema":{"type":"string","enum":["created_at"],"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-phone-numbers-job-delete-phone-numbers":{"post":{"operationId":"communication_telnyx_create_phone_numbers_job_delete_phone_numbers","summary":"Delete a batch of numbers","description":"POST /phone_numbers/jobs/delete_phone_numbers","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-phone-numbers-job-update-emergency-settings":{"post":{"operationId":"communication_telnyx_create_phone_numbers_job_update_emergency_settings","summary":"Update the emergency settings from a batch of numbers","description":"POST /phone_numbers/jobs/update_emergency_settings","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-phone-numbers-job-update-phone-number":{"post":{"operationId":"communication_telnyx_create_phone_numbers_job_update_phone_number","summary":"Update a batch of numbers","description":"POST /phone_numbers/jobs/update_phone_numbers","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-phone-numbers-job":{"get":{"operationId":"communication_telnyx_retrieve_phone_numbers_job","summary":"Retrieve a phone numbers job","description":"GET /phone_numbers/jobs/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the Phone Numbers Job.","schema":{"type":"string","description":"Identifies the Phone Numbers Job."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-phone-numbers-with-messaging-settings":{"get":{"operationId":"communication_telnyx_list_phone_numbers_with_messaging_settings","summary":"List phone numbers with messaging settings","description":"GET /phone_numbers/messaging","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-phone-numbers-with-voice-settings":{"get":{"operationId":"communication_telnyx_list_phone_numbers_with_voice_settings","summary":"List phone numbers with voice settings","description":"GET /phone_numbers/voice","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[phone_number]","in":"query","required":false,"description":"Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.","schema":{"type":"string","description":"Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned."}},{"name":"filter[connection_name][contains]","in":"query","required":false,"description":"Filter contains connection name. Requires at least three characters.","schema":{"type":"string","description":"Filter contains connection name. Requires at least three characters."}},{"name":"filter[customer_reference]","in":"query","required":false,"description":"Filter numbers via the customer_reference set.","schema":{"type":"string","description":"Filter numbers via the customer_reference set."}},{"name":"filter[usage_payment_method]","in":"query","required":false,"description":"Filter by usage_payment_method.","schema":{"type":"string","enum":["pay-per-minute","channel"],"description":"Filter by usage_payment_method."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order.","schema":{"type":"string","enum":["purchased_at","phone_number","connection_name","usage_payment_method"],"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-phone-number":{"get":{"operationId":"communication_telnyx_retrieve_phone_number","summary":"Retrieve a phone number","description":"GET /phone_numbers/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-phone-number":{"post":{"operationId":"communication_telnyx_update_phone_number","summary":"Update a phone number","description":"PATCH /phone_numbers/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-phone-number":{"post":{"operationId":"communication_telnyx_delete_phone_number","summary":"Delete a phone number","description":"DELETE /phone_numbers/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/enable-emergency-phone-number":{"post":{"operationId":"communication_telnyx_enable_emergency_phone_number","summary":"Enable emergency for a phone number","description":"POST /phone_numbers/{id}/actions/enable_emergency","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-phone-number-with-messaging-settings":{"get":{"operationId":"communication_telnyx_retrieve_phone_number_with_messaging_settings","summary":"Retrieve a phone number with messaging settings","description":"GET /phone_numbers/{id}/messaging","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the type of resource.","schema":{"type":"string","description":"Identifies the type of resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-phone-number-with-messaging-settings":{"post":{"operationId":"communication_telnyx_update_phone_number_with_messaging_settings","summary":"Update a phone number with messaging settings","description":"PATCH /phone_numbers/{id}/messaging","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the type of resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-phone-number-with-voice-settings":{"get":{"operationId":"communication_telnyx_retrieve_phone_number_with_voice_settings","summary":"Retrieve a phone number with voice settings","description":"GET /phone_numbers/{id}/voice","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-phone-number-with-voice-settings":{"post":{"operationId":"communication_telnyx_update_phone_number_with_voice_settings","summary":"Update a phone number with voice settings","description":"PATCH /phone_numbers/{id}/voice","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/post-portability-check":{"post":{"operationId":"communication_telnyx_post_portability_check","summary":"Run a portability check","description":"POST /portability_checks","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-porting-orders":{"get":{"operationId":"communication_telnyx_list_porting_orders","summary":"List all porting orders","description":"GET /porting_orders","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"include_phone_numbers","in":"query","required":false,"description":"Include the first 50 phone number objects in the results","schema":{"type":"boolean","default":true,"description":"Include the first 50 phone number objects in the results"}},{"name":"filter[status]","in":"query","required":false,"description":"Filter results by status","schema":{"type":"object","description":"Filter results by status"}},{"name":"filter[customer_reference]","in":"query","required":false,"description":"Filter results by user reference","schema":{"type":"string","description":"Filter results by user reference"},"example":"123abc"},{"name":"filter[phone_numbers][country_code]","in":"query","required":false,"description":"Filter results by country ISO 3166-1 alpha-2 code","schema":{"type":"string","description":"Filter results by country ISO 3166-1 alpha-2 code"},"example":"US"},{"name":"filter[phone_numbers][carrier_name]","in":"query","required":false,"description":"Filter results by old service provider","schema":{"type":"string","description":"Filter results by old service provider"},"example":"Telnyx"},{"name":"filter[misc][type]","in":"query","required":false,"description":"Filter results by porting order type","schema":{"type":"string","enum":["full","partial"],"description":"Filter results by porting order type"},"example":"full"},{"name":"filter[end_user][admin][entity_name]","in":"query","required":false,"description":"Filter results by person or company name","schema":{"type":"string","description":"Filter results by person or company name"},"example":"Porter McPortersen"},{"name":"filter[end_user][admin][auth_person_name]","in":"query","required":false,"description":"Filter results by authorized person","schema":{"type":"string","description":"Filter results by authorized person"},"example":"Admin McPortersen"},{"name":"filter[activation_settings][fast_port_eligible]","in":"query","required":false,"description":"Filter results by fast port eligible","schema":{"type":"boolean","description":"Filter results by fast port eligible"},"example":false},{"name":"filter[activation_settings][foc_datetime_requested][gt]","in":"query","required":false,"description":"Filter results by foc date later than this value","schema":{"type":"string","description":"Filter results by foc date later than this value"},"example":"2025-10-15T13:52:39.185Z"},{"name":"filter[activation_settings][foc_datetime_requested][lt]","in":"query","required":false,"description":"Filter results by foc date earlier than this value","schema":{"type":"string","description":"Filter results by foc date earlier than this value"},"example":"2025-10-15T13:52:39.185Z"},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order.","schema":{"type":"string","enum":["created_at","-created_at","activation_settings.foc_datetime_requested","-activation_settings.foc_datetime_requested"],"description":"Specifies the sort order for results. If not given, results are sorted by created_at in descending order."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-porting-order":{"post":{"operationId":"communication_telnyx_create_porting_order","summary":"Create a porting order","description":"POST /porting_orders","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-porting-orders-exception-types":{"get":{"operationId":"communication_telnyx_list_porting_orders_exception_types","summary":"List all exception types","description":"GET /porting_orders/exception_types","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-porting-order":{"get":{"operationId":"communication_telnyx_get_porting_order","summary":"Retrieve a porting order","description":"GET /porting_orders/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Porting Order id","schema":{"type":"string","description":"Porting Order id"}},{"name":"include_phone_numbers","in":"query","required":false,"description":"Include the first 50 phone number objects in the results","schema":{"type":"boolean","default":true,"description":"Include the first 50 phone number objects in the results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-porting-order":{"post":{"operationId":"communication_telnyx_update_porting_order","summary":"Edit a porting order","description":"PATCH /porting_orders/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Porting Order id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-porting-order":{"post":{"operationId":"communication_telnyx_delete_porting_order","summary":"Request cancellation","description":"DELETE /porting_orders/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Porting Order id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/activate-porting-order":{"post":{"operationId":"communication_telnyx_activate_porting_order","summary":"Activates every number on a porting order.","description":"POST /porting_orders/{id}/actions/activate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Porting Order id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/cancel-porting-order":{"post":{"operationId":"communication_telnyx_cancel_porting_order","summary":"Cancel this porting order","description":"POST /porting_orders/{id}/actions/cancel","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Porting Order id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/confirm-porting-order":{"post":{"operationId":"communication_telnyx_confirm_porting_order","summary":"Confirms the porting order is ready to be actioned.","description":"POST /porting_orders/{id}/actions/confirm","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Porting Order id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-porting-orders-activation-jobs":{"get":{"operationId":"communication_telnyx_list_porting_orders_activation_jobs","summary":"List all porting activation jobs","description":"GET /porting_orders/{id}/activation_jobs","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Porting Order id","schema":{"type":"string","description":"Porting Order id"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-porting-orders-activation-job":{"get":{"operationId":"communication_telnyx_get_porting_orders_activation_job","summary":"Retrieve a porting activation job","description":"GET /porting_orders/{id}/activation_jobs/{activationJobId}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Porting Order id","schema":{"type":"string","description":"Porting Order id"}},{"name":"activationJobId","in":"query","required":true,"description":"Activation Job Identifier","schema":{"type":"string","description":"Activation Job Identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-porting-orders-comments":{"get":{"operationId":"communication_telnyx_list_porting_orders_comments","summary":"List all comments of a porting order","description":"GET /porting_orders/{id}/comments","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Porting Order id","schema":{"type":"string","description":"Porting Order id"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-porting-order-comment":{"post":{"operationId":"communication_telnyx_create_porting_order_comment","summary":"Create a comment for a porting order","description":"POST /porting_orders/{id}/comments","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Porting Order id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-porting-order-loatemplate":{"get":{"operationId":"communication_telnyx_get_porting_order_loatemplate","summary":"Download a porting order loa template","description":"GET /porting_orders/{id}/loa_template","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Porting Order id","schema":{"type":"string","description":"Porting Order id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-porting-phone-numbers":{"get":{"operationId":"communication_telnyx_get_porting_phone_numbers","summary":"List all porting phone numbers","description":"GET /porting_phone_numbers","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[porting_order_id]","in":"query","required":false,"description":"Filter results by porting order id","schema":{"type":"string","description":"Filter results by porting order id"}},{"name":"filter[phone_number]","in":"query","required":false,"description":"Filter results by phone number","schema":{"type":"string","description":"Filter results by phone number"}},{"name":"filter[activation_status]","in":"query","required":false,"description":"Filter results by activation status","schema":{"type":"string","enum":["New","Pending","Conflict","Cancel Pending","Failed","Concurred","Activate RDY","Disconnect Pending","Concurrence Sent","Old","Sending","Active","Canceled"],"description":"Filter results by activation status"}},{"name":"filter[portability_status]","in":"query","required":false,"description":"Filter results by portability status","schema":{"type":"string","enum":["pending","confirmed","provisional"],"description":"Filter results by portability status"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-portout-request":{"get":{"operationId":"communication_telnyx_list_portout_request","summary":"Retrieve a list of portout requests","description":"GET /portouts","tags":["communication"],"parameters":[{"name":"filter[carrier_name]","in":"query","required":false,"description":"Filter by new carrier name.","schema":{"type":"string","description":"Filter by new carrier name."}},{"name":"filter[spid]","in":"query","required":false,"description":"Filter by new carrier spid.","schema":{"type":"string","description":"Filter by new carrier spid."}},{"name":"filter[status]","in":"query","required":false,"description":"Filter by portout status.","schema":{"type":"string","enum":["pending","authorized","ported","rejected","rejected-pending","canceled"],"description":"Filter by portout status."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-portout-request":{"get":{"operationId":"communication_telnyx_find_portout_request","summary":"Retrieve a portout request","description":"GET /portouts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Portout id","schema":{"type":"string","description":"Portout id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-portout-comments":{"get":{"operationId":"communication_telnyx_find_portout_comments","summary":"List all comments for a portout request","description":"GET /portouts/{id}/comments","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Portout id","schema":{"type":"string","description":"Portout id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/post-port-request-comment":{"post":{"operationId":"communication_telnyx_post_port_request_comment","summary":"Create a comment on a portout request","description":"POST /portouts/{id}/comments","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Portout id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-portout-request":{"post":{"operationId":"communication_telnyx_update_portout_request","summary":"Update Status","description":"PATCH /portouts/{id}/{status}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","status"],"properties":{"id":{"type":"string","description":"Portout id"},"status":{"type":"string","enum":["authorized","rejected"],"description":"Updated portout status"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-private-wireless-gateways":{"get":{"operationId":"communication_telnyx_get_private_wireless_gateways","summary":"Get all Private Wireless Gateways","description":"GET /private_wireless_gateways","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[name]","in":"query","required":false,"description":"The name of the Private Wireless Gateway.","schema":{"type":"string","description":"The name of the Private Wireless Gateway."},"example":"my private gateway"},{"name":"filter[ip_range]","in":"query","required":false,"description":"The IP address range of the Private Wireless Gateway.","schema":{"type":"string","description":"The IP address range of the Private Wireless Gateway."},"example":"192.168.0.0/24"},{"name":"filter[region_code]","in":"query","required":false,"description":"The name of the region where the Private Wireless Gateway is deployed.","schema":{"type":"string","description":"The name of the region where the Private Wireless Gateway is deployed."},"example":"ashburn-va"},{"name":"filter[created_at]","in":"query","required":false,"description":"Private Wireless Gateway resource creation date.","schema":{"type":"string","description":"Private Wireless Gateway resource creation date."},"example":"2025-10-15T13:52:39.185Z"},{"name":"filter[updated_at]","in":"query","required":false,"description":"When the Private Wireless Gateway was last updated.","schema":{"type":"string","description":"When the Private Wireless Gateway was last updated."},"example":"2025-10-15T13:52:39.185Z"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-private-wireless-gateway":{"post":{"operationId":"communication_telnyx_create_private_wireless_gateway","summary":"Create a Private Wireless Gateway","description":"POST /private_wireless_gateways","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-private-wireless-gateway":{"get":{"operationId":"communication_telnyx_get_private_wireless_gateway","summary":"Get a Private Wireless Gateway","description":"GET /private_wireless_gateways/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-private-wireless-gateway":{"post":{"operationId":"communication_telnyx_delete_private_wireless_gateway","summary":"Delete a Private Wireless Gateway","description":"DELETE /private_wireless_gateways/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-call-queue":{"get":{"operationId":"communication_telnyx_retrieve_call_queue","summary":"Retrieve a call queue","description":"GET /queues/{queue_name}","tags":["communication"],"parameters":[{"name":"queue_name","in":"query","required":true,"description":"Uniquely identifies the queue by name","schema":{"type":"string","description":"Uniquely identifies the queue by name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-queue-calls":{"get":{"operationId":"communication_telnyx_list_queue_calls","summary":"Retrieve calls from a queue","description":"GET /queues/{queue_name}/calls","tags":["communication"],"parameters":[{"name":"queue_name","in":"query","required":true,"description":"Uniquely identifies the queue by name","schema":{"type":"string","description":"Uniquely identifies the queue by name"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-call-from-queue":{"get":{"operationId":"communication_telnyx_retrieve_call_from_queue","summary":"Retrieve a call from a queue","description":"GET /queues/{queue_name}/calls/{call_control_id}","tags":["communication"],"parameters":[{"name":"queue_name","in":"query","required":true,"description":"Uniquely identifies the queue by name","schema":{"type":"string","description":"Uniquely identifies the queue by name"}},{"name":"call_control_id","in":"query","required":true,"description":"Unique identifier and token for controlling the call","schema":{"type":"string","description":"Unique identifier and token for controlling the call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-recordings":{"get":{"operationId":"communication_telnyx_list_recordings","summary":"List recordings","description":"GET /recordings","tags":["communication"],"parameters":[{"name":"filter[conference_id]","in":"query","required":false,"description":"Return only recordings associated with a given conference","schema":{"type":"string","description":"Return only recordings associated with a given conference"}},{"name":"filter[created_at][gte]","in":"query","required":false,"description":"Return only recordings created later than or at given ISO 8601 datetime","schema":{"type":"string","description":"Return only recordings created later than or at given ISO 8601 datetime"}},{"name":"filter[created_at][lte]","in":"query","required":false,"description":"Return only recordings created earlier than or at given ISO 8601 datetime","schema":{"type":"string","description":"Return only recordings created earlier than or at given ISO 8601 datetime"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-recording":{"get":{"operationId":"communication_telnyx_retrieve_recording","summary":"Retrieve a recording","description":"GET /recordings/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Uniquely identifies the recording","schema":{"type":"string","description":"Uniquely identifies the recording"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-cdr-requests":{"get":{"operationId":"communication_telnyx_get_cdr_requests","summary":"Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling…","description":"GET /reports/batch_mdr_reports","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"page[size]","in":"query","required":false,"description":"Size of the page","schema":{"type":"integer","default":20,"description":"Size of the page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/submit-mdr-request":{"post":{"operationId":"communication_telnyx_submit_mdr_request","summary":"Submit a request for new messaging detail report. Messaging detail report pulls all raw messaging data…","description":"POST /reports/batch_mdr_reports","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-mdr-request":{"get":{"operationId":"communication_telnyx_get_mdr_request","summary":"Fetch single messaging detail report by id.","description":"GET /reports/batch_mdr_reports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-mdr-request":{"post":{"operationId":"communication_telnyx_delete_mdr_request","summary":"Delete generated messaging detail report by id","description":"DELETE /reports/batch_mdr_reports/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-usage-report-sync":{"get":{"operationId":"communication_telnyx_get_usage_report_sync","summary":"Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice…","description":"GET /reports/cdr_usage_reports/sync","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"aggregation_type","in":"query","required":true,"schema":{"type":"string","enum":["NO_AGGREGATION","CONNECTION","TAG","BILLING_GROUP"]}},{"name":"product_breakdown","in":"query","required":true,"schema":{"type":"string","enum":["NO_BREAKDOWN","DID_VS_TOLL_FREE","COUNTRY","DID_VS_TOLL_FREE_PER_COUNTRY"]}},{"name":"connections","in":"query","required":false,"schema":{"type":"array"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-usage-reports":{"get":{"operationId":"communication_telnyx_get_usage_reports","summary":"Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and…","description":"GET /reports/mdr_usage_reports","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"page[size]","in":"query","required":false,"description":"Size of the page","schema":{"type":"integer","default":20,"description":"Size of the page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/submit-usage-report":{"post":{"operationId":"communication_telnyx_submit_usage_report","summary":"Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in…","description":"POST /reports/mdr_usage_reports","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-usage-report-sync-1":{"get":{"operationId":"communication_telnyx_get_usage_report_sync_1","summary":"Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the…","description":"GET /reports/mdr_usage_reports/sync","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"aggregation_type","in":"query","required":true,"schema":{"type":"string","enum":["NO_AGGREGATION","PROFILE","TAGS"]}},{"name":"profiles","in":"query","required":false,"schema":{"type":"array"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-usage-report":{"get":{"operationId":"communication_telnyx_get_usage_report","summary":"Fetch a single messaging usage report by id","description":"GET /reports/mdr_usage_reports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-usage-report":{"post":{"operationId":"communication_telnyx_delete_usage_report","summary":"Delete messaging usage report by id","description":"DELETE /reports/mdr_usage_reports/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-reports-mdrs":{"get":{"operationId":"communication_telnyx_get_reports_mdrs","summary":"Fetch all Mdr records","description":"GET /reports/mdrs","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":false,"description":"Pagination start date","schema":{"type":"string","description":"Pagination start date"}},{"name":"end_date","in":"query","required":false,"description":"Pagination end date","schema":{"type":"string","description":"Pagination end date"}},{"name":"id","in":"query","required":false,"description":"Message uuid","schema":{"type":"string","description":"Message uuid"}},{"name":"direction","in":"query","required":false,"description":"Direction (inbound or outbound)","schema":{"type":"string","enum":["INBOUND","OUTBOUND"],"description":"Direction (inbound or outbound)"}},{"name":"profile","in":"query","required":false,"description":"Name of the profile","schema":{"type":"string","description":"Name of the profile"}},{"name":"cld","in":"query","required":false,"description":"Destination number","schema":{"type":"string","description":"Destination number"}},{"name":"cli","in":"query","required":false,"description":"Origination number","schema":{"type":"string","description":"Origination number"}},{"name":"status","in":"query","required":false,"description":"Message status","schema":{"type":"string","enum":["GW_TIMEOUT","DELIVERED","DLR_UNCONFIRMED","DLR_TIMEOUT","RECEIVED","GW_REJECT","FAILED"],"description":"Message status"}},{"name":"message_type","in":"query","required":false,"description":"Type of message","schema":{"type":"string","enum":["SMS","MMS"],"description":"Type of message"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-paginated-wdrs":{"get":{"operationId":"communication_telnyx_get_paginated_wdrs","summary":"Fetch all Wdr records","description":"GET /reports/wdrs","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":false,"description":"Start date","schema":{"type":"string","description":"Start date"}},{"name":"end_date","in":"query","required":false,"description":"End date","schema":{"type":"string","description":"End date"}},{"name":"id","in":"query","required":false,"description":"WDR uuid","schema":{"type":"string","description":"WDR uuid"}},{"name":"mcc","in":"query","required":false,"description":"Mobile country code","schema":{"type":"string","description":"Mobile country code"}},{"name":"mnc","in":"query","required":false,"description":"Mobile network code","schema":{"type":"string","description":"Mobile network code"}},{"name":"imsi","in":"query","required":false,"description":"International mobile subscriber identity","schema":{"type":"string","description":"International mobile subscriber identity"}},{"name":"sim_group_name","in":"query","required":false,"description":"Sim group name","schema":{"type":"string","description":"Sim group name"}},{"name":"sim_group_id","in":"query","required":false,"description":"Sim group unique identifier","schema":{"type":"string","description":"Sim group unique identifier"}},{"name":"sim_card_id","in":"query","required":false,"description":"Sim card unique identifier","schema":{"type":"string","description":"Sim card unique identifier"}},{"name":"phone_number","in":"query","required":false,"description":"Phone number","schema":{"type":"string","description":"Phone number"}},{"name":"page[number]","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"page[size]","in":"query","required":false,"description":"Size of the page","schema":{"type":"integer","default":20,"description":"Size of the page"}},{"name":"sort","in":"query","required":false,"description":"Field used to order the data. If no field is specified, default value is 'created_at'","schema":{"type":"array","default":"created_at","description":"Field used to order the data. If no field is specified, default value is 'created_at'"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/doc-reqs-list-requirement-types":{"get":{"operationId":"communication_telnyx_doc_reqs_list_requirement_types","summary":"List all requirement types","description":"GET /requirement_types","tags":["communication"],"parameters":[{"name":"filter[name][contains]","in":"query","required":false,"description":"Filters requirement types to those whose name contains a certain string.","schema":{"type":"string","description":"Filters requirement types to those whose name contains a certain string."}},{"name":"sort[]","in":"query","required":false,"description":"Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to…","schema":{"type":"string","enum":["created_at","name","updated_at"],"description":"Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/doc-reqs-retrieve-requirement-type":{"get":{"operationId":"communication_telnyx_doc_reqs_retrieve_requirement_type","summary":"Retrieve a requirement types","description":"GET /requirement_types/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Uniquely identifies the requirement_type record","schema":{"type":"string","description":"Uniquely identifies the requirement_type record"},"example":"a38c217a-8019-48f8-bff6-0fdd9939075b"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-requirements":{"get":{"operationId":"communication_telnyx_list_requirements","summary":"List all requirements","description":"GET /requirements","tags":["communication"],"parameters":[{"name":"filter[country_code]","in":"query","required":false,"description":"Filters results to those applying to a 2-character (ISO 3166-1 alpha-2) country code","schema":{"type":"string","description":"Filters results to those applying to a 2-character (ISO 3166-1 alpha-2) country code"}},{"name":"filter[phone_number_type]","in":"query","required":false,"description":"Filters results to those applying to a specific `phone_number_type`","schema":{"type":"string","enum":["local","national","toll-free"],"description":"Filters results to those applying to a specific `phone_number_type`"}},{"name":"filter[action]","in":"query","required":false,"description":"Filters requirements to those applying to a specific action.","schema":{"type":"string","enum":["ordering","porting"],"description":"Filters requirements to those applying to a specific action."}},{"name":"sort[]","in":"query","required":false,"description":"Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to…","schema":{"type":"string","enum":["action","country_code","locality","phone_number_type"],"description":"Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to…"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/doc-reqs-retrieve-document-requirements":{"get":{"operationId":"communication_telnyx_doc_reqs_retrieve_document_requirements","summary":"Retrieve a document requirement","description":"GET /requirements/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Uniquely identifies the requirement_type record","schema":{"type":"string","description":"Uniquely identifies the requirement_type record"},"example":"a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-room-participants":{"get":{"operationId":"communication_telnyx_list_room_participants","summary":"View a list of room participants.","description":"GET /room_participants","tags":["communication"],"parameters":[{"name":"filter[date_joined_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that joined on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that joined on that date."}},{"name":"filter[date_joined_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that joined after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that joined after that date."}},{"name":"filter[date_joined_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that joined before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that joined before that date."}},{"name":"filter[date_updated_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants updated on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants updated on that date."}},{"name":"filter[date_updated_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants updated after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants updated after that date."}},{"name":"filter[date_updated_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants updated before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants updated before that date."}},{"name":"filter[date_left_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that left on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that left on that date."}},{"name":"filter[date_left_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that left after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that left after that date."}},{"name":"filter[date_left_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that left before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that left before that date."}},{"name":"filter[context]","in":"query","required":false,"description":"Filter room participants based on the context.","schema":{"type":"string","description":"Filter room participants based on the context."}},{"name":"filter[session_id]","in":"query","required":false,"description":"Session_id for filtering room participants.","schema":{"type":"string","description":"Session_id for filtering room participants."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/view-room-participant":{"get":{"operationId":"communication_telnyx_view_room_participant","summary":"View a room participant.","description":"GET /room_participants/{room_participant_id}","tags":["communication"],"parameters":[{"name":"room_participant_id","in":"query","required":true,"description":"The unique identifier of a room participant.","schema":{"type":"string","description":"The unique identifier of a room participant."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-room-sessions":{"get":{"operationId":"communication_telnyx_list_room_sessions","summary":"View a list of room sessions.","description":"GET /room_sessions","tags":["communication"],"parameters":[{"name":"filter[date_created_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions created on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions created on that date."}},{"name":"filter[date_created_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions created after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions created after that date."}},{"name":"filter[date_created_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions created before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions created before that date."}},{"name":"filter[date_updated_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions updated on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions updated on that date."}},{"name":"filter[date_updated_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions updated after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions updated after that date."}},{"name":"filter[date_updated_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions updated before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions updated before that date."}},{"name":"filter[date_ended_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions ended on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions ended on that date."}},{"name":"filter[date_ended_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions ended after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions ended after that date."}},{"name":"filter[date_ended_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions ended before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions ended before that date."}},{"name":"filter[room_id]","in":"query","required":false,"description":"Room_id for filtering room sessions.","schema":{"type":"string","description":"Room_id for filtering room sessions."}},{"name":"filter[active]","in":"query","required":false,"description":"Filter active or inactive room sessions.","schema":{"type":"boolean","description":"Filter active or inactive room sessions."}},{"name":"include_participants","in":"query","required":false,"description":"To decide if room participants should be included in the response.","schema":{"type":"boolean","description":"To decide if room participants should be included in the response."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/view-room-session":{"get":{"operationId":"communication_telnyx_view_room_session","summary":"View a room session.","description":"GET /room_sessions/{room_session_id}","tags":["communication"],"parameters":[{"name":"room_session_id","in":"query","required":true,"description":"The unique identifier of a room session.","schema":{"type":"string","description":"The unique identifier of a room session."}},{"name":"include_participants","in":"query","required":false,"description":"To decide if room participants should be included in the response.","schema":{"type":"boolean","description":"To decide if room participants should be included in the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/nested-list-room-participants":{"get":{"operationId":"communication_telnyx_nested_list_room_participants","summary":"View a list of room participants.","description":"GET /room_sessions/{room_session_id}/participants","tags":["communication"],"parameters":[{"name":"room_session_id","in":"query","required":true,"description":"The unique identifier of a room session.","schema":{"type":"string","description":"The unique identifier of a room session."}},{"name":"filter[date_joined_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that joined on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that joined on that date."}},{"name":"filter[date_joined_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that joined after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that joined after that date."}},{"name":"filter[date_joined_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that joined before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that joined before that date."}},{"name":"filter[date_updated_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants updated on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants updated on that date."}},{"name":"filter[date_updated_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants updated after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants updated after that date."}},{"name":"filter[date_updated_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants updated before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants updated before that date."}},{"name":"filter[date_left_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that left on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that left on that date."}},{"name":"filter[date_left_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that left after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that left after that date."}},{"name":"filter[date_left_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room participants that left before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room participants that left before that date."}},{"name":"filter[context]","in":"query","required":false,"description":"Filter room participants based on the context.","schema":{"type":"string","description":"Filter room participants based on the context."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-rooms":{"get":{"operationId":"communication_telnyx_list_rooms","summary":"View a list of rooms.","description":"GET /rooms","tags":["communication"],"parameters":[{"name":"filter[date_created_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering rooms created on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering rooms created on that date."}},{"name":"filter[date_created_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering rooms created after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering rooms created after that date."}},{"name":"filter[date_created_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering rooms created before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering rooms created before that date."}},{"name":"filter[date_updated_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering rooms updated on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering rooms updated on that date."}},{"name":"filter[date_updated_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering rooms updated after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering rooms updated after that date."}},{"name":"filter[date_updated_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering rooms updated before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering rooms updated before that date."}},{"name":"filter[unique_name]","in":"query","required":false,"description":"Unique_name for filtering rooms.","schema":{"type":"string","description":"Unique_name for filtering rooms."}},{"name":"include_sessions","in":"query","required":false,"description":"To decide if room sessions should be included in the response.","schema":{"type":"boolean","description":"To decide if room sessions should be included in the response."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-room":{"post":{"operationId":"communication_telnyx_create_room","summary":"Create a room.","description":"POST /rooms","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/view-room":{"get":{"operationId":"communication_telnyx_view_room","summary":"View a room.","description":"GET /rooms/{room_id}","tags":["communication"],"parameters":[{"name":"room_id","in":"query","required":true,"description":"The unique identifier of a room.","schema":{"type":"string","description":"The unique identifier of a room."}},{"name":"include_sessions","in":"query","required":false,"description":"To decide if room sessions should be included in the response.","schema":{"type":"boolean","description":"To decide if room sessions should be included in the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-room":{"post":{"operationId":"communication_telnyx_delete_room","summary":"Delete a room.","description":"DELETE /rooms/{room_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["room_id"],"properties":{"room_id":{"type":"string","description":"The unique identifier of a room."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-room-client-token":{"post":{"operationId":"communication_telnyx_create_room_client_token","summary":"Create Client Token to join a room.","description":"POST /rooms/{room_id}/actions/generate_join_client_token","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["room_id","body"],"properties":{"room_id":{"type":"string","description":"The unique identifier of a room."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/refresh-room-client-token":{"post":{"operationId":"communication_telnyx_refresh_room_client_token","summary":"Refresh Client Token to join a room.","description":"POST /rooms/{room_id}/actions/refresh_client_token","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["room_id","body"],"properties":{"room_id":{"type":"string","description":"The unique identifier of a room."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/nested-list-room-sessions":{"get":{"operationId":"communication_telnyx_nested_list_room_sessions","summary":"View a list of room sessions.","description":"GET /rooms/{room_id}/sessions","tags":["communication"],"parameters":[{"name":"room_id","in":"query","required":true,"description":"The unique identifier of a room.","schema":{"type":"string","description":"The unique identifier of a room."}},{"name":"filter[date_created_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions created on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions created on that date."}},{"name":"filter[date_created_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions created after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions created after that date."}},{"name":"filter[date_created_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions created before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions created before that date."}},{"name":"filter[date_updated_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions updated on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions updated on that date."}},{"name":"filter[date_updated_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions updated after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions updated after that date."}},{"name":"filter[date_updated_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions updated before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions updated before that date."}},{"name":"filter[date_ended_at][eq]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions ended on that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions ended on that date."}},{"name":"filter[date_ended_at][gte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions ended after that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions ended after that date."}},{"name":"filter[date_ended_at][lte]","in":"query","required":false,"description":"ISO 8601 date for filtering room sessions ended before that date.","schema":{"type":"string","description":"ISO 8601 date for filtering room sessions ended before that date."}},{"name":"filter[active]","in":"query","required":false,"description":"Filter active or inactive room sessions.","schema":{"type":"boolean","description":"Filter active or inactive room sessions."}},{"name":"include_participants","in":"query","required":false,"description":"To decide if room participants should be included in the response.","schema":{"type":"boolean","description":"To decide if room participants should be included in the response."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-short-codes":{"get":{"operationId":"communication_telnyx_list_short_codes","summary":"List short codes","description":"GET /short_codes","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[messaging_profile_id]","in":"query","required":false,"description":"Filter by Messaging Profile ID. Use the string `null` for phone numbers without assigned profiles. A synonym for the…","schema":{"type":"string","description":"Filter by Messaging Profile ID. Use the string `null` for phone numbers without assigned profiles. A synonym for the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-short-code":{"get":{"operationId":"communication_telnyx_retrieve_short_code","summary":"Retrieve a short code","description":"GET /short_codes/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"The id of the short code","schema":{"type":"string","description":"The id of the short code"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-short-code":{"post":{"operationId":"communication_telnyx_update_short_code","summary":"Update short code","description":"PATCH /short_codes/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"The id of the short code"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-group-actions-get":{"get":{"operationId":"communication_telnyx_sim_card_group_actions_get","summary":"List SIM card group actions","description":"GET /sim_card_group_actions","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[sim_card_group_id]","in":"query","required":false,"description":"A valid SIM card group ID.","schema":{"type":"string","description":"A valid SIM card group ID."}},{"name":"filter[status]","in":"query","required":false,"description":"Filter by a specific status of the resource's lifecycle.","schema":{"type":"string","enum":["in-progress","completed","failed"],"description":"Filter by a specific status of the resource's lifecycle."}},{"name":"filter[type]","in":"query","required":false,"description":"Filter by action type.","schema":{"type":"string","enum":["set_private_wireless_gateway","remove_private_wireless_gateway"],"description":"Filter by action type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-group-action-get":{"get":{"operationId":"communication_telnyx_sim_card_group_action_get","summary":"Get SIM card group action details","description":"GET /sim_card_group_actions/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-groups-get-all":{"get":{"operationId":"communication_telnyx_sim_card_groups_get_all","summary":"Get all SIM card groups","description":"GET /sim_card_groups","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[name]","in":"query","required":false,"description":"A valid SIM card group name.","schema":{"type":"string","description":"A valid SIM card group name."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-groups-post":{"post":{"operationId":"communication_telnyx_sim_card_groups_post","summary":"Create a SIM card group","description":"POST /sim_card_groups","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-groups-get":{"get":{"operationId":"communication_telnyx_sim_card_groups_get","summary":"Get SIM card group","description":"GET /sim_card_groups/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-group-update":{"post":{"operationId":"communication_telnyx_sim_card_group_update","summary":"Update a SIM card group","description":"PATCH /sim_card_groups/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-group-delete":{"post":{"operationId":"communication_telnyx_sim_card_group_delete","summary":"Delete a SIM card group","description":"DELETE /sim_card_groups/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/remove-simcard-group-private-wireless-gateway":{"post":{"operationId":"communication_telnyx_remove_simcard_group_private_wireless_gateway","summary":"Request Private Wireless Gateway removal from SIM card group","description":"POST /sim_card_groups/{id}/actions/remove_private_wireless_gateway","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/set-simcard-group-private-wireless-gateway":{"post":{"operationId":"communication_telnyx_set_simcard_group_private_wireless_gateway","summary":"Request Private Wireless Gateway assignment for SIM card group","description":"POST /sim_card_groups/{id}/actions/set_private_wireless_gateway","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-orders-preview":{"post":{"operationId":"communication_telnyx_sim_card_orders_preview","summary":"Preview SIM card orders","description":"POST /sim_card_order_preview","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-orders-get":{"get":{"operationId":"communication_telnyx_sim_card_orders_get","summary":"Get all SIM card orders","description":"GET /sim_card_orders","tags":["communication"],"parameters":[{"name":"filter[created_at]","in":"query","required":false,"description":"Filter by ISO 8601 formatted date-time string matching resource creation date-time.","schema":{"type":"string","description":"Filter by ISO 8601 formatted date-time string matching resource creation date-time."}},{"name":"filter[updated_at]","in":"query","required":false,"description":"Filter by ISO 8601 formatted date-time string matching resource last update date-time.","schema":{"type":"string","description":"Filter by ISO 8601 formatted date-time string matching resource last update date-time."}},{"name":"filter[quantity]","in":"query","required":false,"description":"Filter orders by how many SIM cards were ordered.","schema":{"type":"integer","description":"Filter orders by how many SIM cards were ordered."}},{"name":"filter[cost.amount]","in":"query","required":false,"description":"The total monetary amount of the order.","schema":{"type":"string","description":"The total monetary amount of the order."}},{"name":"filter[cost.currency]","in":"query","required":false,"description":"Filter by ISO 4217 currency string.","schema":{"type":"string","description":"Filter by ISO 4217 currency string."}},{"name":"filter[address.id]","in":"query","required":false,"description":"Uniquely identifies the address for the order.","schema":{"type":"string","description":"Uniquely identifies the address for the order."}},{"name":"filter[address.street_address]","in":"query","required":false,"description":"Returns entries with matching name of the street where the address is located.","schema":{"type":"string","description":"Returns entries with matching name of the street where the address is located."}},{"name":"filter[address.extended_address]","in":"query","required":false,"description":"Returns entries with matching name of the supplemental field for address information.","schema":{"type":"string","description":"Returns entries with matching name of the supplemental field for address information."}},{"name":"filter[address.locality]","in":"query","required":false,"description":"Filter by the name of the city where the address is located.","schema":{"type":"string","description":"Filter by the name of the city where the address is located."}},{"name":"filter[address.administrative_area]","in":"query","required":false,"description":"Filter by state or province where the address is located.","schema":{"type":"string","description":"Filter by state or province where the address is located."}},{"name":"filter[address.country_code]","in":"query","required":false,"description":"Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code.","schema":{"type":"string","description":"Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code."}},{"name":"filter[address.postal_code]","in":"query","required":false,"description":"Filter by postal code for the address.","schema":{"type":"string","description":"Filter by postal code for the address."}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-orders-post":{"post":{"operationId":"communication_telnyx_sim_card_orders_post","summary":"Create a SIM card order","description":"POST /sim_card_orders","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-order-get":{"get":{"operationId":"communication_telnyx_sim_card_order_get","summary":"Get a single SIM card order","description":"GET /sim_card_orders/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-cards-get":{"get":{"operationId":"communication_telnyx_sim_cards_get","summary":"Get all SIM cards","description":"GET /sim_cards","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"include_sim_card_group","in":"query","required":false,"description":"It includes the associated SIM card group object in the response when present.","schema":{"type":"boolean","default":false,"description":"It includes the associated SIM card group object in the response when present."}},{"name":"filter[sim_card_group_id]","in":"query","required":false,"description":"A valid SIM card group ID.","schema":{"type":"string","description":"A valid SIM card group ID."}},{"name":"filter[tags]","in":"query","required":false,"description":"A list of SIM card tags to filter on. If the SIM card contains all of the given tags they will be found. For example, if the SIM cards…","schema":{"type":"array","description":"A list of SIM card tags to filter on. If the SIM card contains all of the given tags they will be found. For example, if the SIM cards…"}},{"name":"filter[iccid]","in":"query","required":false,"description":"A search string to partially match for the SIM card's ICCID.","schema":{"type":"string","description":"A search string to partially match for the SIM card's ICCID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/post-validate-registration-codes":{"post":{"operationId":"communication_telnyx_post_validate_registration_codes","summary":"Validate SIM cards registration codes","description":"POST /sim_cards/actions/validate_registration_codes","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-get":{"get":{"operationId":"communication_telnyx_sim_card_get","summary":"Get SIM card","description":"GET /sim_cards/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}},{"name":"include_sim_card_group","in":"query","required":false,"description":"It includes the associated SIM card group object in the response when present.","schema":{"type":"boolean","default":false,"description":"It includes the associated SIM card group object in the response when present."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-update":{"post":{"operationId":"communication_telnyx_sim_card_update","summary":"Update a SIM card","description":"PATCH /sim_cards/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-delete":{"post":{"operationId":"communication_telnyx_sim_card_delete","summary":"Deletes a SIM card","description":"DELETE /sim_cards/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-disable":{"post":{"operationId":"communication_telnyx_sim_card_disable","summary":"Request a SIM card disable","description":"POST /sim_cards/{id}/actions/disable","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-enable":{"post":{"operationId":"communication_telnyx_sim_card_enable","summary":"Request a SIM card enable","description":"POST /sim_cards/{id}/actions/enable","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/sim-card-set-standby":{"post":{"operationId":"communication_telnyx_sim_card_set_standby","summary":"Request setting a SIM card to standby","description":"POST /sim_cards/{id}/actions/set_standby","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/simcard-network-preferences-get":{"get":{"operationId":"communication_telnyx_simcard_network_preferences_get","summary":"Get network preferences","description":"GET /sim_cards/{sim_card_id}/network_preferences","tags":["communication"],"parameters":[{"name":"sim_card_id","in":"query","required":true,"description":"Identifies a SIM card.","schema":{"type":"string","description":"Identifies a SIM card."}},{"name":"include_ota_updates","in":"query","required":false,"description":"It includes the associated OTA update objects in the response when present.","schema":{"type":"boolean","default":false,"description":"It includes the associated OTA update objects in the response when present."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/simcard-network-preferences-put":{"post":{"operationId":"communication_telnyx_simcard_network_preferences_put","summary":"Set network preferences","description":"PUT /sim_cards/{sim_card_id}/network_preferences","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sim_card_id"],"properties":{"sim_card_id":{"type":"string","description":"Identifies a SIM card."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/simcard-network-preferences-delete":{"post":{"operationId":"communication_telnyx_simcard_network_preferences_delete","summary":"DELETE network preferences","description":"DELETE /sim_cards/{sim_card_id}/network_preferences","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sim_card_id"],"properties":{"sim_card_id":{"type":"string","description":"Identifies a SIM card."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/simcard-public-ipget":{"get":{"operationId":"communication_telnyx_simcard_public_ipget","summary":"Get SIM card public IP definition","description":"GET /sim_cards/{sim_card_id}/public_ip","tags":["communication"],"parameters":[{"name":"sim_card_id","in":"query","required":true,"description":"Identifies a SIM card.","schema":{"type":"string","description":"Identifies a SIM card."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/simcard-public-ippost":{"post":{"operationId":"communication_telnyx_simcard_public_ippost","summary":"Set SIM card public IP","description":"POST /sim_cards/{sim_card_id}/public_ip","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sim_card_id"],"properties":{"sim_card_id":{"type":"string","description":"Identifies a SIM card."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/simcard-public-ipdelete":{"post":{"operationId":"communication_telnyx_simcard_public_ipdelete","summary":"Delete SIM card public IP","description":"DELETE /sim_cards/{sim_card_id}/public_ip","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sim_card_id"],"properties":{"sim_card_id":{"type":"string","description":"Identifies a SIM card."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/wireless-connectivity-logs-get":{"get":{"operationId":"communication_telnyx_wireless_connectivity_logs_get","summary":"List wireless connectivity logs","description":"GET /sim_cards/{sim_card_id}/wireless_connectivity_logs","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"sim_card_id","in":"query","required":true,"description":"Identifies a SIM card.","schema":{"type":"string","description":"Identifies a SIM card."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-sub-number-orders":{"get":{"operationId":"communication_telnyx_list_sub_number_orders","summary":"List sub number orders","description":"GET /sub_number_orders","tags":["communication"],"parameters":[{"name":"filter[user_id]","in":"query","required":false,"description":"User ID of the user who owns the sub number order","schema":{"type":"string","description":"User ID of the user who owns the sub number order"}},{"name":"filter[order_request_id]","in":"query","required":false,"description":"ID of the number order the sub number order belongs to","schema":{"type":"string","description":"ID of the number order the sub number order belongs to"}},{"name":"filter[country_code]","in":"query","required":false,"description":"ISO alpha-2 country code.","schema":{"type":"string","description":"ISO alpha-2 country code."}},{"name":"filter[phone_number_type]","in":"query","required":false,"description":"Phone Number Type","schema":{"type":"string","description":"Phone Number Type"}},{"name":"filter[phone_numbers_count]","in":"query","required":false,"description":"Amount of numbers in the sub number order","schema":{"type":"integer","description":"Amount of numbers in the sub number order"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-sub-number-order":{"get":{"operationId":"communication_telnyx_retrieve_sub_number_order","summary":"Retrieve a sub number order","description":"GET /sub_number_orders/{sub_number_order_id}","tags":["communication"],"parameters":[{"name":"sub_number_order_id","in":"query","required":true,"description":"The sub number order ID.","schema":{"type":"string","description":"The sub number order ID."}},{"name":"filter[include_phone_numbers]","in":"query","required":false,"description":"Include the first 50 phone number objects in the results","schema":{"type":"boolean","default":false,"description":"Include the first 50 phone number objects in the results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-sub-number-order":{"post":{"operationId":"communication_telnyx_update_sub_number_order","summary":"Update a sub number order","description":"PATCH /sub_number_orders/{sub_number_order_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sub_number_order_id","body"],"properties":{"sub_number_order_id":{"type":"string","description":"The sub number order ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-telephony-credentials":{"get":{"operationId":"communication_telnyx_find_telephony_credentials","summary":"List all credentials","description":"GET /telephony_credentials","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[tag]","in":"query","required":false,"description":"Filter by tag","schema":{"type":"string","description":"Filter by tag"}},{"name":"filter[name]","in":"query","required":false,"description":"Filter by name","schema":{"type":"string","description":"Filter by name"}},{"name":"filter[status]","in":"query","required":false,"description":"Filter by status","schema":{"type":"string","description":"Filter by status"}},{"name":"filter[resource_id]","in":"query","required":false,"description":"Filter by resource_id","schema":{"type":"string","description":"Filter by resource_id"}},{"name":"filter[sip_username]","in":"query","required":false,"description":"Filter by sip_username","schema":{"type":"string","description":"Filter by sip_username"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-telephony-credential":{"post":{"operationId":"communication_telnyx_create_telephony_credential","summary":"Create a credential","description":"POST /telephony_credentials","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-tags":{"get":{"operationId":"communication_telnyx_list_tags","summary":"List all tags","description":"GET /telephony_credentials/tags","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-telephony-credential":{"get":{"operationId":"communication_telnyx_get_telephony_credential","summary":"Get a credential","description":"GET /telephony_credentials/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-telephony-credential":{"post":{"operationId":"communication_telnyx_update_telephony_credential","summary":"Update a credential","description":"PATCH /telephony_credentials/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-telephony-credential":{"post":{"operationId":"communication_telnyx_delete_telephony_credential","summary":"Delete a credential","description":"DELETE /telephony_credentials/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/telephony-credential-action":{"post":{"operationId":"communication_telnyx_telephony_credential_action","summary":"Perform activate or deactivate action on provided Credential","description":"POST /telephony_credentials/{id}/actions/{action}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","action"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"action":{"type":"string","enum":["activate","deactivate"],"description":"Identifies the action to be taken."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-telephony-credential-token":{"post":{"operationId":"communication_telnyx_create_telephony_credential_token","summary":"Create an Access Token.","description":"POST /telephony_credentials/{id}/token","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/find-texml-applications":{"get":{"operationId":"communication_telnyx_find_texml_applications","summary":"List all TeXML Applications","description":"GET /texml_applications","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}},{"name":"filter[friendly_name][contains]","in":"query","required":false,"description":"If present, applications with friendly_name containing the given value will be returned. Matching is not case-sensitive. Requires at least…","schema":{"type":"string","default":"null","description":"If present, applications with friendly_name containing the given value will be returned. Matching is not case-sensitive. Requires at least…"}},{"name":"filter[outbound_voice_profile_id]","in":"query","required":false,"description":"Identifies the associated outbound voice profile.","schema":{"type":"string","description":"Identifies the associated outbound voice profile."}},{"name":"sort","in":"query","required":false,"description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…","schema":{"type":"string","enum":["created_at","connection_name","active"],"default":"created_at","description":"Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-texml-application":{"post":{"operationId":"communication_telnyx_create_texml_application","summary":"Creates a TeXML Application","description":"POST /texml_applications","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-texml-application":{"get":{"operationId":"communication_telnyx_get_texml_application","summary":"Retrieve a TeXML Application","description":"GET /texml_applications/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-texml-application":{"post":{"operationId":"communication_telnyx_update_texml_application","summary":"Update a TeXML Application","description":"PATCH /texml_applications/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Identifies the resource."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-texml-application":{"post":{"operationId":"communication_telnyx_delete_texml_application","summary":"Deletes a TeXML Application","description":"DELETE /texml_applications/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-verifications":{"get":{"operationId":"communication_telnyx_list_verifications","summary":"List verifications by phone number","description":"GET /verifications/by_phone_number/{phone_number}","tags":["communication"],"parameters":[{"name":"phone_number","in":"query","required":true,"description":"The phone number associated with the verifications to retrieve.","schema":{"type":"string","description":"The phone number associated with the verifications to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/verify-verification-code":{"post":{"operationId":"communication_telnyx_verify_verification_code","summary":"Submit a verification code","description":"POST /verifications/by_phone_number/{phone_number}/actions/verify","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone_number","body"],"properties":{"phone_number":{"type":"string","description":"The phone number associated with the verification code being verified."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-verification-call":{"post":{"operationId":"communication_telnyx_create_verification_call","summary":"Trigger a Call verification","description":"POST /verifications/call","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-verification-flashcall":{"post":{"operationId":"communication_telnyx_create_verification_flashcall","summary":"Trigger a Flash call verification","description":"POST /verifications/flashcall","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-verification-psd2":{"post":{"operationId":"communication_telnyx_create_verification_psd2","summary":"Trigger a PSD2 verification","description":"POST /verifications/psd2","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-verification-sms":{"post":{"operationId":"communication_telnyx_create_verification_sms","summary":"Trigger a SMS verification","description":"POST /verifications/sms","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-verification-whatsapp":{"post":{"operationId":"communication_telnyx_create_verification_whatsapp","summary":"Trigger a Whatsapp verification","description":"POST /verifications/whatsapp","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-verification":{"get":{"operationId":"communication_telnyx_retrieve_verification","summary":"Retrieve a verification","description":"GET /verifications/{verification_id}","tags":["communication"],"parameters":[{"name":"verification_id","in":"query","required":true,"description":"The identifier of the verification to retrieve.","schema":{"type":"string","description":"The identifier of the verification to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/list-verify-profiles":{"get":{"operationId":"communication_telnyx_list_verify_profiles","summary":"List all Verify profiles","description":"GET /verify_profiles","tags":["communication"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"Optional filter for profile names.","schema":{"type":"string","description":"Optional filter for profile names."}},{"name":"page[size]","in":"query","required":false,"schema":{"type":"integer","default":25}},{"name":"page[number]","in":"query","required":false,"schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-verify-profile":{"post":{"operationId":"communication_telnyx_create_verify_profile","summary":"Create a Verify profile","description":"POST /verify_profiles","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/retrieve-verify-profile":{"get":{"operationId":"communication_telnyx_retrieve_verify_profile","summary":"Retrieve a Verify profile","description":"GET /verify_profiles/{verify_profile_id}","tags":["communication"],"parameters":[{"name":"verify_profile_id","in":"query","required":true,"description":"The identifier of the Verify profile to retrieve.","schema":{"type":"string","description":"The identifier of the Verify profile to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-verify-profile":{"post":{"operationId":"communication_telnyx_update_verify_profile","summary":"Update a Verify profile","description":"PATCH /verify_profiles/{verify_profile_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["verify_profile_id","body"],"properties":{"verify_profile_id":{"type":"string","description":"The identifier of the Verify profile to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-verify-profile":{"post":{"operationId":"communication_telnyx_delete_verify_profile","summary":"Delete a Verify profile","description":"DELETE /verify_profiles/{verify_profile_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["verify_profile_id"],"properties":{"verify_profile_id":{"type":"string","description":"The identifier of the Verify profile to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-webhook-deliveries":{"get":{"operationId":"communication_telnyx_get_webhook_deliveries","summary":"List webhook deliveries","description":"GET /webhook_deliveries","tags":["communication"],"parameters":[{"name":"filter[status][eq]","in":"query","required":false,"description":"Return only webhook_deliveries matching the given `status`","schema":{"type":"string","enum":["delivered","failed"],"description":"Return only webhook_deliveries matching the given `status`"}},{"name":"filter[webhook][contains]","in":"query","required":false,"description":"Return only webhook deliveries whose `webhook` component contains the given text","schema":{"type":"string","description":"Return only webhook deliveries whose `webhook` component contains the given text"}},{"name":"filter[attempts][contains]","in":"query","required":false,"description":"Return only webhook_deliveries whose `attempts` component contains the given text","schema":{"type":"string","description":"Return only webhook_deliveries whose `attempts` component contains the given text"}},{"name":"filter[started_at][gte]","in":"query","required":false,"description":"Return only webhook_deliveries whose delivery started later than or at given ISO 8601 datetime","schema":{"type":"string","description":"Return only webhook_deliveries whose delivery started later than or at given ISO 8601 datetime"}},{"name":"filter[started_at][lte]","in":"query","required":false,"description":"Return only webhook_deliveries whose delivery started earlier than or at given ISO 8601 datetime","schema":{"type":"string","description":"Return only webhook_deliveries whose delivery started earlier than or at given ISO 8601 datetime"}},{"name":"filter[finished_at][gte]","in":"query","required":false,"description":"Return only webhook_deliveries whose delivery finished later than or at given ISO 8601 datetime","schema":{"type":"string","description":"Return only webhook_deliveries whose delivery finished later than or at given ISO 8601 datetime"}},{"name":"filter[finished_at][lte]","in":"query","required":false,"description":"Return only webhook_deliveries whose delivery finished earlier than or at given ISO 8601 datetime","schema":{"type":"string","description":"Return only webhook_deliveries whose delivery finished earlier than or at given ISO 8601 datetime"}},{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-webhook-delivery":{"get":{"operationId":"communication_telnyx_get_webhook_delivery","summary":"Find webhook_delivery details by ID","description":"GET /webhook_deliveries/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Uniquely identifies the webhook_delivery.","schema":{"type":"string","description":"Uniquely identifies the webhook_delivery."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/check-contact":{"post":{"operationId":"communication_telnyx_check_contact","summary":"Check Contact","description":"POST /whatsapp_contacts","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-requests":{"get":{"operationId":"communication_telnyx_get_requests","summary":"Fetch all previous requests for WhatsApp detail reports. WhatsApp detail reports are reports for pulling all…","description":"GET /whatsapp_detail_record_reports","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"Page number","schema":{"type":"integer","default":1,"description":"Page number"}},{"name":"page[size]","in":"query","required":false,"description":"Size of the page","schema":{"type":"integer","default":20,"description":"Size of the page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/submit-request":{"post":{"operationId":"communication_telnyx_submit_request","summary":"Submit a request for new WhatsApp detail report. WhatsApp detail report pulls all raw WhatsApp data…","description":"POST /whatsapp_detail_record_reports","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-request":{"get":{"operationId":"communication_telnyx_get_request","summary":"Fetch single whatsapp detail report by id.","description":"GET /whatsapp_detail_record_reports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-request":{"post":{"operationId":"communication_telnyx_delete_request","summary":"Delete generated WhatsApp detail report by id","description":"DELETE /whatsapp_detail_record_reports/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/upload-media":{"post":{"operationId":"communication_telnyx_upload_media","summary":"Upload Media","description":"POST /whatsapp_media","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-whatsapp-media-whatsapp-user-id-media-id":{"get":{"operationId":"communication_telnyx_get_whatsapp_media_whatsapp_user_id_media_id","summary":"Download Media","description":"GET /whatsapp_media/{whatsapp_user_id}/{media_id}","tags":["communication"],"parameters":[{"name":"whatsapp_user_id","in":"query","required":true,"description":"User's WhatsApp ID","schema":{"type":"string","description":"User's WhatsApp ID"}},{"name":"media_id","in":"query","required":true,"description":"WhatsApp's Media ID","schema":{"type":"string","description":"WhatsApp's Media ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-whatsapp-media-whatsapp-user-id-media-id":{"post":{"operationId":"communication_telnyx_delete_whatsapp_media_whatsapp_user_id_media_id","summary":"Delete Media","description":"DELETE /whatsapp_media/{whatsapp_user_id}/{media_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["whatsapp_user_id","media_id"],"properties":{"whatsapp_user_id":{"type":"string","description":"User's WhatsApp ID"},"media_id":{"type":"string","description":"WhatsApp's Media ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/send-message":{"post":{"operationId":"communication_telnyx_send_message","summary":"Send Message","description":"POST /whatsapp_messages","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/mark-message-as-read":{"post":{"operationId":"communication_telnyx_mark_message_as_read","summary":"Mark Message As Read","description":"PATCH /whatsapp_messages/{message_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message_id","body"],"properties":{"message_id":{"type":"string","description":"Message ID from Webhook"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-usage-aggregations-sync":{"get":{"operationId":"communication_telnyx_get_usage_aggregations_sync","summary":"Generate and fetch WhatsApp usage aggregations synchronously. This endpoint will both generate and fetch the…","description":"GET /whatsapp_usage_aggregations","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":false,"schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-user":{"get":{"operationId":"communication_telnyx_get_user","summary":"Get User","description":"GET /whatsapp_users/{whatsapp_user_id}","tags":["communication"],"parameters":[{"name":"whatsapp_user_id","in":"query","required":true,"description":"User's WhatsApp ID","schema":{"type":"string","description":"User's WhatsApp ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/update-whats-app-webhook":{"post":{"operationId":"communication_telnyx_update_whats_app_webhook","summary":"Update WhatsApp User","description":"PATCH /whatsapp_users/{whatsapp_user_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["whatsapp_user_id","body"],"properties":{"whatsapp_user_id":{"type":"string","description":"User's WhatsApp ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-wdr-reports":{"get":{"operationId":"communication_telnyx_get_wdr_reports","summary":"Get all Wireless Detail Records (WDRs) Reports","description":"GET /wireless/detail_records_reports","tags":["communication"],"parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page number to load.","schema":{"type":"integer","default":1,"description":"The page number to load."}},{"name":"page[size]","in":"query","required":false,"description":"The size of the page.","schema":{"type":"integer","default":20,"description":"The size of the page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/create-wdr-report":{"post":{"operationId":"communication_telnyx_create_wdr_report","summary":"Create a Wireless Detail Records (WDRs) Report","description":"POST /wireless/detail_records_reports","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:telnyx/get-wdr-report":{"get":{"operationId":"communication_telnyx_get_wdr_report","summary":"Get a Wireless Detail Record (WDR) Report","description":"GET /wireless/detail_records_reports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Identifies the resource.","schema":{"type":"string","description":"Identifies the resource."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:telnyx/delete-wdr-report":{"post":{"operationId":"communication_telnyx_delete_wdr_report","summary":"Delete a Wireless Detail Record (WDR) Report","description":"DELETE /wireless/detail_records_reports/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Identifies the resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}