telnyx-mcp 6.73.1 → 6.73.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/local-docs-search.js +9 -9
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +9 -9
- package/local-docs-search.mjs.map +1 -1
- package/package.json +2 -2
- package/server.js +1 -1
- package/server.mjs +1 -1
- package/src/local-docs-search.ts +9 -9
- package/src/server.ts +1 -1
package/local-docs-search.js
CHANGED
|
@@ -50480,37 +50480,37 @@ const EMBEDDED_METHODS = [
|
|
|
50480
50480
|
description: 'Returns the live SIP registration state of a UAC connection: whether it is currently registered, when it last registered, and the last response Telnyx received from the registrar. Only `uac_external_credential` is supported today.',
|
|
50481
50481
|
stainlessPath: '(resource) sip_registration_status > (method) retrieve',
|
|
50482
50482
|
qualified: 'client.sipRegistrationStatus.retrieve',
|
|
50483
|
-
params: ['connection_id: string;', "credential_type: 'uac_external_credential';"
|
|
50483
|
+
params: ['connection_id: string;', "credential_type: 'uac_external_credential';"],
|
|
50484
50484
|
response: "{ b2bua_external?: object; b2bua_internal?: object; connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; external_state?: string; external_uac_settings?: { auth_username?: string; expiration_sec?: number; from_user?: string; outbound_proxy?: string; password?: string; proxy?: string; transport?: 'TCP' | 'UDP' | 'TLS'; username?: string; }; internal_uac_settings?: { destination_uri?: string; }; last_registration_response?: string; pair_state?: string; registered?: boolean; user_id?: string; username?: string; }",
|
|
50485
|
-
markdown: "## retrieve\n\n`client.sipRegistrationStatus.retrieve(connection_id: string, credential_type: 'uac_external_credential'
|
|
50485
|
+
markdown: "## retrieve\n\n`client.sipRegistrationStatus.retrieve(connection_id: string, credential_type: 'uac_external_credential'): { b2bua_external?: object; b2bua_internal?: object; connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; external_state?: string; external_uac_settings?: object; internal_uac_settings?: object; last_registration_response?: string; pair_state?: string; registered?: boolean; user_id?: string; username?: string; }`\n\n**get** `/sip_registration_status`\n\nReturns the live SIP registration state of a UAC connection: whether it is currently registered, when it last registered, and the last response Telnyx received from the registrar. Only `uac_external_credential` is supported today.\n\n### Parameters\n\n- `connection_id: string`\n Identifier of the UAC connection to look up.\n\n- `credential_type: 'uac_external_credential'`\n The kind of credential to look up. Only `uac_external_credential` is supported today.\n\n### Returns\n\n- `{ b2bua_external?: object; b2bua_internal?: object; connection_id?: string; connection_name?: string; credential_type?: 'uac_external_credential'; external_state?: string; external_uac_settings?: { auth_username?: string; expiration_sec?: number; from_user?: string; outbound_proxy?: string; password?: string; proxy?: string; transport?: 'TCP' | 'UDP' | 'TLS'; username?: string; }; internal_uac_settings?: { destination_uri?: string; }; last_registration_response?: string; pair_state?: string; registered?: boolean; user_id?: string; username?: string; }`\n\n - `b2bua_external?: object`\n - `b2bua_internal?: object`\n - `connection_id?: string`\n - `connection_name?: string`\n - `credential_type?: 'uac_external_credential'`\n - `external_state?: string`\n - `external_uac_settings?: { auth_username?: string; expiration_sec?: number; from_user?: string; outbound_proxy?: string; password?: string; proxy?: string; transport?: 'TCP' | 'UDP' | 'TLS'; username?: string; }`\n - `internal_uac_settings?: { destination_uri?: string; }`\n - `last_registration_response?: string`\n - `pair_state?: string`\n - `registered?: boolean`\n - `user_id?: string`\n - `username?: string`\n\n### Example\n\n```typescript\nimport Telnyx from 'telnyx';\n\nconst client = new Telnyx();\n\nconst sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({ connection_id: 'connection_id', credential_type: 'uac_external_credential' });\n\nconsole.log(sipRegistrationStatus);\n```",
|
|
50486
50486
|
perLanguage: {
|
|
50487
50487
|
typescript: {
|
|
50488
50488
|
method: 'client.sipRegistrationStatus.retrieve',
|
|
50489
|
-
example: "import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({\n connection_id: 'connection_id',\n credential_type: 'uac_external_credential',\n
|
|
50489
|
+
example: "import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({\n connection_id: 'connection_id',\n credential_type: 'uac_external_credential',\n});\n\nconsole.log(sipRegistrationStatus.connection_id);",
|
|
50490
50490
|
},
|
|
50491
50491
|
python: {
|
|
50492
50492
|
method: 'sip_registration_status.retrieve',
|
|
50493
|
-
example: 'import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted\n)\nsip_registration_status = client.sip_registration_status.retrieve(\n connection_id="connection_id",\n credential_type="uac_external_credential",\n
|
|
50493
|
+
example: 'import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted\n)\nsip_registration_status = client.sip_registration_status.retrieve(\n connection_id="connection_id",\n credential_type="uac_external_credential",\n)\nprint(sip_registration_status.connection_id)',
|
|
50494
50494
|
},
|
|
50495
50495
|
java: {
|
|
50496
50496
|
method: 'sipRegistrationStatus().retrieve',
|
|
50497
|
-
example: 'package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveParams;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n SipRegistrationStatusRetrieveParams params = SipRegistrationStatusRetrieveParams.builder()\n .connectionId("connection_id")\n .credentialType(SipRegistrationStatusRetrieveParams.CredentialType.UAC_EXTERNAL_CREDENTIAL)\n .
|
|
50497
|
+
example: 'package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveParams;\nimport com.telnyx.sdk.models.sipregistrationstatus.SipRegistrationStatusRetrieveResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n SipRegistrationStatusRetrieveParams params = SipRegistrationStatusRetrieveParams.builder()\n .connectionId("connection_id")\n .credentialType(SipRegistrationStatusRetrieveParams.CredentialType.UAC_EXTERNAL_CREDENTIAL)\n .build();\n SipRegistrationStatusRetrieveResponse sipRegistrationStatus = client.sipRegistrationStatus().retrieve(params);\n }\n}',
|
|
50498
50498
|
},
|
|
50499
50499
|
go: {
|
|
50500
50500
|
method: 'client.SipRegistrationStatus.Get',
|
|
50501
|
-
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/team-telnyx/telnyx-go"\n\t"github.com/team-telnyx/telnyx-go/option"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsipRegistrationStatus, err := client.SipRegistrationStatus.Get(context.TODO(), telnyx.SipRegistrationStatusGetParams{\n\t\tConnectionID: "connection_id",\n\t\tCredentialType: telnyx.SipRegistrationStatusGetParamsCredentialTypeUacExternalCredential,\n\t
|
|
50501
|
+
example: 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/team-telnyx/telnyx-go"\n\t"github.com/team-telnyx/telnyx-go/option"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey("My API Key"),\n\t)\n\tsipRegistrationStatus, err := client.SipRegistrationStatus.Get(context.TODO(), telnyx.SipRegistrationStatusGetParams{\n\t\tConnectionID: "connection_id",\n\t\tCredentialType: telnyx.SipRegistrationStatusGetParamsCredentialTypeUacExternalCredential,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sipRegistrationStatus.ConnectionID)\n}\n',
|
|
50502
50502
|
},
|
|
50503
50503
|
ruby: {
|
|
50504
50504
|
method: 'sip_registration_status.retrieve',
|
|
50505
|
-
example: 'require "telnyx"\n\ntelnyx = Telnyx::Client.new(api_key: "My API Key")\n\nsip_registration_status = telnyx.sip_registration_status.retrieve(\n connection_id: "connection_id",\n credential_type: :uac_external_credential
|
|
50505
|
+
example: 'require "telnyx"\n\ntelnyx = Telnyx::Client.new(api_key: "My API Key")\n\nsip_registration_status = telnyx.sip_registration_status.retrieve(\n connection_id: "connection_id",\n credential_type: :uac_external_credential\n)\n\nputs(sip_registration_status)',
|
|
50506
50506
|
},
|
|
50507
50507
|
cli: {
|
|
50508
50508
|
method: 'sip_registration_status retrieve',
|
|
50509
|
-
example: "telnyx sip-registration-status retrieve \\\n --api-key 'My API Key' \\\n --connection-id connection_id \\\n --credential-type uac_external_credential
|
|
50509
|
+
example: "telnyx sip-registration-status retrieve \\\n --api-key 'My API Key' \\\n --connection-id connection_id \\\n --credential-type uac_external_credential",
|
|
50510
50510
|
},
|
|
50511
50511
|
php: {
|
|
50512
50512
|
method: 'sipRegistrationStatus->retrieve',
|
|
50513
|
-
example: "<?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\n$client = new Client(apiKey: 'My API Key');\n\n$sipRegistrationStatus = $client->sipRegistrationStatus->retrieve(\n connectionID: 'connection_id'
|
|
50513
|
+
example: "<?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\n$client = new Client(apiKey: 'My API Key');\n\n$sipRegistrationStatus = $client->sipRegistrationStatus->retrieve(\n connectionID: 'connection_id', credentialType: 'uac_external_credential'\n);\n\nvar_dump($sipRegistrationStatus);",
|
|
50514
50514
|
},
|
|
50515
50515
|
http: {
|
|
50516
50516
|
example: 'curl https://api.telnyx.com/v2/sip_registration_status \\\n -H "Authorization: Bearer $TELNYX_API_KEY"',
|