Update a Mobile Phone Number

PATCH /v2/mobile_phone_numbers/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const mobilePhoneNumber = await client.mobilePhoneNumbers.update('id');

console.log(mobilePhoneNumber.data);

200

{
  "data": {
    "id": "<string>",
    "record_type": "mobile_phone_number",
    "phone_number": "<string>",
    "sim_card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "connection_id": "<string>",
    "connection_name": "<string>",
    "connection_type": "<string>",
    "mobile_voice_enabled": true,
    "tags": [
      "<string>"
    ],
    "customer_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "call_forwarding": {
      "call_forwarding_enabled": true,
      "forwards_to": "<string>",
      "forwarding_type": "always"
    },
    "country_iso_alpha2": "<string>",
    "noise_suppression": "inbound",
    "inbound_call_screening": "disabled",
    "caller_id_name_enabled": true,
    "call_recording": {
      "inbound_call_recording_enabled": true,
      "inbound_call_recording_channels": "single",
      "inbound_call_recording_format": "wav"
    },
    "cnam_listing": {
      "cnam_listing_enabled": true,
      "cnam_listing_details": "<string>"
    },
    "outbound": {
      "interception_app_id": "<string>",
      "interception_app_name": "<string>"
    },
    "inbound": {
      "interception_app_id": "<string>",
      "interception_app_name": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The ID of the mobile phone number

Body

application/json

customer_reference · string | null

connection_id · string | null

noise_suppression · boolean

inbound_call_screening · enum<string>

Available options: disabled, reject_calls, flag_calls

caller_id_name_enabled · boolean

tags · string[]

inbound · object

Show child attributes

outbound · object

Show child attributes

call_forwarding · object

Show child attributes

cnam_listing · object

Show child attributes

call_recording · object

Show child attributes

Response

200

application/json

Successful response

data · object

Show child attributes