Sign in
numbers

Link Number

post/v1/numbers/link

Request body

phone_numberstring required
telephony_account_connectionstring uuid required
outbound_onlyboolean

Response

Successful Response

idstring uuid required
user_idstring uuid required
activeboolean
labelstring
outbound_onlyboolean
example_contextobject nullable
numberstring required
telephony_provider'vonage' | 'twilio'

Changes

Changed in 12 of the 31 revisions of this API.152928

  • ffca17c004e22See the full diff
    • ○

      added the new optional request property inbound_agent/anyOf[subschema #1: AgentParams]/idle_time_seconds

      new-optional-request-property

    • ○

      added the optional property inbound_agent/anyOf[subschema #1: Agent]/idle_time_seconds to the response with the 200 status

      response-optional-property-added

  • 63991d99e2e113193See the full diff
    • ▲

      the response property inbound_agent became optional for the status 200

      response-property-became-optional

    • ▲

      response property example_context list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      the inbound_agent response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the telephony_account_connection response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property inbound_agent/actions from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property inbound_agent/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property inbound_agent/prompt from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property inbound_agent/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property inbound_agent/voice from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/credentials from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/user_id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property inbound_agent/ask_if_human_present_on_idle from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/context_endpoint from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/conversation_speed from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/endpointing_sensitivity from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/initial_message from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/initial_message_delay from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/interrupt_sensitivity from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/ivr_navigation_mode from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/language from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/llm_temperature from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/noise_suppression from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/openai_account_connection from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/openai_model_name_override from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/run_do_not_call_detection from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/vector_database from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property inbound_agent/webhook from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property telephony_account_connection/account_supports_any_caller_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property telephony_account_connection/steering_pool from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property inbound_agent

      new-optional-request-property

    • ○

      added Agent subschema #2 to the inbound_agent response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added TwilioAccountConnection subschema #2 to the telephony_account_connection response property anyOf list for the response status 200

      response-property-any-of-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 47ab17602d6415See the full diff
    • ▲

      added ExternalAction to the inbound_agent/actions/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property inbound_agent/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #2: RimeVoice]/model_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property telephony_account_connection/account_supports_any_caller_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property telephony_account_connection/steering_pool to the response with the 200 status

      response-optional-property-added

    • ○

      added action_external discriminator mapping keys to the inbound_agent/actions/items/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 3dbe7b5c464d1See the full diff
    • ○

      added the optional property inbound_agent/llm_temperature to the response with the 200 status

      response-optional-property-added

  • 500a519452b015See the full diff
    • ●

      added the new event_phone_call_did_not_connect enum value to the inbound_agent/webhook/subscriptions/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #3: ElevenLabsVoice]/experimental_input_streaming to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #4: PlayHtVoice]/experimental_remove_silence to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #4: PlayHtVoice]/text_guidance to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #4: PlayHtVoice]/top_p to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #4: PlayHtVoice]/voice_guidance to the response with the 200 status

      response-optional-property-added

  • 5086814bf16a14See the full diff
    • ▲

      added AddToConferenceAction SetHoldAction to the inbound_agent/actions/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property inbound_agent/actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/actions/items/oneOf[subschema #3: DTMFAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added action_add_to_conference action_set_hold discriminator mapping keys to the inbound_agent/actions/items/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 1111aff32f0a81See the full diff
    • ●

      added the new fr enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hi enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new id enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new it enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ja enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ko enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new nl enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pt enum value to the inbound_agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property inbound_agent/ask_if_human_present_on_idle to the response with the 200 status

      response-optional-property-added

  • 5d83963279c92See the full diff
    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #4: PlayHtVoice]/quality to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property inbound_agent/voice/oneOf[subschema #4: PlayHtVoice]/temperature to the response with the 200 status

      response-optional-property-added

  • 17fa3c507aa211See the full diff
    • ●

      added the new sensitive enum value to the inbound_agent/endpointing_sensitivity response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property inbound_agent/run_do_not_call_detection to the response with the 200 status

      response-optional-property-added

  • e5b6e245d5221See the full diff
    • ○

      the interrupt_sensitivity response's property default value changed from high to low for the status 200

      response-property-default-value-changed