telnyx 6.35.0 → 6.36.0
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/CHANGELOG.md +14 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/enterprises/enterprises.d.mts +2 -2
- package/resources/enterprises/enterprises.d.mts.map +1 -1
- package/resources/enterprises/enterprises.d.ts +2 -2
- package/resources/enterprises/enterprises.d.ts.map +1 -1
- package/resources/enterprises/index.d.mts +1 -1
- package/resources/enterprises/index.d.mts.map +1 -1
- package/resources/enterprises/index.d.ts +1 -1
- package/resources/enterprises/index.d.ts.map +1 -1
- package/resources/enterprises/reputation/index.d.mts +2 -2
- package/resources/enterprises/reputation/index.d.mts.map +1 -1
- package/resources/enterprises/reputation/index.d.ts +2 -2
- package/resources/enterprises/reputation/index.d.ts.map +1 -1
- package/resources/enterprises/reputation/numbers.d.mts +43 -43
- package/resources/enterprises/reputation/numbers.d.mts.map +1 -1
- package/resources/enterprises/reputation/numbers.d.ts +43 -43
- package/resources/enterprises/reputation/numbers.d.ts.map +1 -1
- package/resources/enterprises/reputation/numbers.js +31 -31
- package/resources/enterprises/reputation/numbers.js.map +1 -1
- package/resources/enterprises/reputation/numbers.mjs +31 -31
- package/resources/enterprises/reputation/numbers.mjs.map +1 -1
- package/resources/enterprises/reputation/reputation.d.mts +45 -46
- package/resources/enterprises/reputation/reputation.d.mts.map +1 -1
- package/resources/enterprises/reputation/reputation.d.ts +45 -46
- package/resources/enterprises/reputation/reputation.d.ts.map +1 -1
- package/resources/enterprises/reputation/reputation.js +43 -44
- package/resources/enterprises/reputation/reputation.js.map +1 -1
- package/resources/enterprises/reputation/reputation.mjs +43 -44
- package/resources/enterprises/reputation/reputation.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/texml/accounts/calls/calls.d.mts +7 -0
- package/resources/texml/accounts/calls/calls.d.mts.map +1 -1
- package/resources/texml/accounts/calls/calls.d.ts +7 -0
- package/resources/texml/accounts/calls/calls.d.ts.map +1 -1
- package/resources/texml/accounts/calls/calls.js.map +1 -1
- package/resources/texml/accounts/calls/calls.mjs.map +1 -1
- package/resources/texml/index.d.mts +1 -1
- package/resources/texml/index.d.mts.map +1 -1
- package/resources/texml/index.d.ts +1 -1
- package/resources/texml/index.d.ts.map +1 -1
- package/resources/texml/index.js.map +1 -1
- package/resources/texml/index.mjs +1 -1
- package/resources/texml/index.mjs.map +1 -1
- package/resources/texml/texml.d.mts +219 -1
- package/resources/texml/texml.d.mts.map +1 -1
- package/resources/texml/texml.d.ts +219 -1
- package/resources/texml/texml.d.ts.map +1 -1
- package/resources/texml/texml.js +26 -0
- package/resources/texml/texml.js.map +1 -1
- package/resources/texml/texml.mjs +26 -0
- package/resources/texml/texml.mjs.map +1 -1
- package/src/client.ts +9 -1
- package/src/resources/enterprises/enterprises.ts +6 -6
- package/src/resources/enterprises/index.ts +3 -3
- package/src/resources/enterprises/reputation/index.ts +6 -6
- package/src/resources/enterprises/reputation/numbers.ts +58 -54
- package/src/resources/enterprises/reputation/reputation.ts +60 -61
- package/src/resources/index.ts +7 -1
- package/src/resources/texml/accounts/calls/calls.ts +8 -0
- package/src/resources/texml/index.ts +7 -1
- package/src/resources/texml/texml.ts +279 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
import { APIResource } from '../../../core/resource';
|
|
4
4
|
import * as NumbersAPI from './numbers';
|
|
5
5
|
import {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
6
|
+
NumberAssociateParams,
|
|
7
|
+
NumberAssociateResponse,
|
|
8
|
+
NumberDisassociateParams,
|
|
9
9
|
NumberListParams,
|
|
10
10
|
NumberRetrieveParams,
|
|
11
11
|
NumberRetrieveResponse,
|
|
@@ -22,50 +22,6 @@ import { path } from '../../../internal/utils/path';
|
|
|
22
22
|
export class Reputation extends APIResource {
|
|
23
23
|
numbers: NumbersAPI.Numbers = new NumbersAPI.Numbers(this._client);
|
|
24
24
|
|
|
25
|
-
/**
|
|
26
|
-
* Enable Number Reputation service for an enterprise.
|
|
27
|
-
*
|
|
28
|
-
* **Requirements:**
|
|
29
|
-
*
|
|
30
|
-
* - Signed LOA (Letter of Authorization) document ID
|
|
31
|
-
* - Reputation check frequency (defaults to `business_daily`)
|
|
32
|
-
* - Number Reputation Terms of Service must be accepted
|
|
33
|
-
*
|
|
34
|
-
* **Flow:**
|
|
35
|
-
*
|
|
36
|
-
* 1. Registers the enterprise for reputation monitoring
|
|
37
|
-
* 2. Creates reputation settings with `pending` status
|
|
38
|
-
* 3. Awaits admin approval before monitoring begins
|
|
39
|
-
*
|
|
40
|
-
* **Resubmission After Rejection:** If a previously rejected record exists, this
|
|
41
|
-
* endpoint will delete it and create a new `pending` record.
|
|
42
|
-
*
|
|
43
|
-
* **Available Frequencies:**
|
|
44
|
-
*
|
|
45
|
-
* - `business_daily` — Monday–Friday
|
|
46
|
-
* - `daily` — Every day
|
|
47
|
-
* - `weekly` — Once per week
|
|
48
|
-
* - `biweekly` — Once every two weeks
|
|
49
|
-
* - `monthly` — Once per month
|
|
50
|
-
* - `never` — Manual refresh only
|
|
51
|
-
*
|
|
52
|
-
* @example
|
|
53
|
-
* ```ts
|
|
54
|
-
* const reputation =
|
|
55
|
-
* await client.enterprises.reputation.create(
|
|
56
|
-
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
57
|
-
* { loa_document_id: 'doc_01HXYZ1234ABCDEF' },
|
|
58
|
-
* );
|
|
59
|
-
* ```
|
|
60
|
-
*/
|
|
61
|
-
create(
|
|
62
|
-
enterpriseID: string,
|
|
63
|
-
body: ReputationCreateParams,
|
|
64
|
-
options?: RequestOptions,
|
|
65
|
-
): APIPromise<ReputationCreateResponse> {
|
|
66
|
-
return this._client.post(path`/enterprises/${enterpriseID}/reputation`, { body, ...options });
|
|
67
|
-
}
|
|
68
|
-
|
|
69
25
|
/**
|
|
70
26
|
* Retrieve the current Number Reputation settings for an enterprise.
|
|
71
27
|
*
|
|
@@ -76,13 +32,13 @@ export class Reputation extends APIResource {
|
|
|
76
32
|
*
|
|
77
33
|
* @example
|
|
78
34
|
* ```ts
|
|
79
|
-
* const
|
|
80
|
-
* await client.enterprises.reputation.
|
|
35
|
+
* const reputation =
|
|
36
|
+
* await client.enterprises.reputation.retrieve(
|
|
81
37
|
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
82
38
|
* );
|
|
83
39
|
* ```
|
|
84
40
|
*/
|
|
85
|
-
|
|
41
|
+
retrieve(enterpriseID: string, options?: RequestOptions): APIPromise<ReputationRetrieveResponse> {
|
|
86
42
|
return this._client.get(path`/enterprises/${enterpriseID}/reputation`, options);
|
|
87
43
|
}
|
|
88
44
|
|
|
@@ -99,18 +55,61 @@ export class Reputation extends APIResource {
|
|
|
99
55
|
*
|
|
100
56
|
* @example
|
|
101
57
|
* ```ts
|
|
102
|
-
* await client.enterprises.reputation.
|
|
58
|
+
* await client.enterprises.reputation.disable(
|
|
103
59
|
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
104
60
|
* );
|
|
105
61
|
* ```
|
|
106
62
|
*/
|
|
107
|
-
|
|
63
|
+
disable(enterpriseID: string, options?: RequestOptions): APIPromise<void> {
|
|
108
64
|
return this._client.delete(path`/enterprises/${enterpriseID}/reputation`, {
|
|
109
65
|
...options,
|
|
110
66
|
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
111
67
|
});
|
|
112
68
|
}
|
|
113
69
|
|
|
70
|
+
/**
|
|
71
|
+
* Enable Number Reputation service for an enterprise.
|
|
72
|
+
*
|
|
73
|
+
* **Requirements:**
|
|
74
|
+
*
|
|
75
|
+
* - Signed LOA (Letter of Authorization) document ID
|
|
76
|
+
* - Reputation check frequency (defaults to `business_daily`)
|
|
77
|
+
* - Number Reputation Terms of Service must be accepted
|
|
78
|
+
*
|
|
79
|
+
* **Flow:**
|
|
80
|
+
*
|
|
81
|
+
* 1. Registers the enterprise for reputation monitoring
|
|
82
|
+
* 2. Creates reputation settings with `pending` status
|
|
83
|
+
* 3. Awaits admin approval before monitoring begins
|
|
84
|
+
*
|
|
85
|
+
* **Resubmission After Rejection:** If a previously rejected record exists, this
|
|
86
|
+
* endpoint will delete it and create a new `pending` record.
|
|
87
|
+
*
|
|
88
|
+
* **Available Frequencies:**
|
|
89
|
+
*
|
|
90
|
+
* - `business_daily` — Monday–Friday
|
|
91
|
+
* - `daily` — Every day
|
|
92
|
+
* - `weekly` — Once per week
|
|
93
|
+
* - `biweekly` — Once every two weeks
|
|
94
|
+
* - `monthly` — Once per month
|
|
95
|
+
* - `never` — Manual refresh only
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```ts
|
|
99
|
+
* const response = await client.enterprises.reputation.enable(
|
|
100
|
+
* '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
|
|
101
|
+
* { loa_document_id: 'doc_01HXYZ1234ABCDEF' },
|
|
102
|
+
* );
|
|
103
|
+
* ```
|
|
104
|
+
*/
|
|
105
|
+
enable(
|
|
106
|
+
enterpriseID: string,
|
|
107
|
+
body: ReputationEnableParams,
|
|
108
|
+
options?: RequestOptions,
|
|
109
|
+
): APIPromise<ReputationEnableResponse> {
|
|
110
|
+
return this._client.post(path`/enterprises/${enterpriseID}/reputation`, { body, ...options });
|
|
111
|
+
}
|
|
112
|
+
|
|
114
113
|
/**
|
|
115
114
|
* Update how often reputation data is automatically refreshed.
|
|
116
115
|
*
|
|
@@ -181,11 +180,11 @@ export interface EnterpriseReputationPublic {
|
|
|
181
180
|
updated_at?: string;
|
|
182
181
|
}
|
|
183
182
|
|
|
184
|
-
export interface
|
|
183
|
+
export interface ReputationRetrieveResponse {
|
|
185
184
|
data?: EnterpriseReputationPublic;
|
|
186
185
|
}
|
|
187
186
|
|
|
188
|
-
export interface
|
|
187
|
+
export interface ReputationEnableResponse {
|
|
189
188
|
data?: EnterpriseReputationPublic;
|
|
190
189
|
}
|
|
191
190
|
|
|
@@ -193,7 +192,7 @@ export interface ReputationUpdateFrequencyResponse {
|
|
|
193
192
|
data?: EnterpriseReputationPublic;
|
|
194
193
|
}
|
|
195
194
|
|
|
196
|
-
export interface
|
|
195
|
+
export interface ReputationEnableParams {
|
|
197
196
|
/**
|
|
198
197
|
* ID of the signed Letter of Authorization (LOA) document uploaded to the document
|
|
199
198
|
* service
|
|
@@ -218,20 +217,20 @@ Reputation.Numbers = Numbers;
|
|
|
218
217
|
export declare namespace Reputation {
|
|
219
218
|
export {
|
|
220
219
|
type EnterpriseReputationPublic as EnterpriseReputationPublic,
|
|
221
|
-
type
|
|
222
|
-
type
|
|
220
|
+
type ReputationRetrieveResponse as ReputationRetrieveResponse,
|
|
221
|
+
type ReputationEnableResponse as ReputationEnableResponse,
|
|
223
222
|
type ReputationUpdateFrequencyResponse as ReputationUpdateFrequencyResponse,
|
|
224
|
-
type
|
|
223
|
+
type ReputationEnableParams as ReputationEnableParams,
|
|
225
224
|
type ReputationUpdateFrequencyParams as ReputationUpdateFrequencyParams,
|
|
226
225
|
};
|
|
227
226
|
|
|
228
227
|
export {
|
|
229
228
|
Numbers as Numbers,
|
|
230
|
-
type NumberCreateResponse as NumberCreateResponse,
|
|
231
229
|
type NumberRetrieveResponse as NumberRetrieveResponse,
|
|
232
|
-
type
|
|
230
|
+
type NumberAssociateResponse as NumberAssociateResponse,
|
|
233
231
|
type NumberRetrieveParams as NumberRetrieveParams,
|
|
234
232
|
type NumberListParams as NumberListParams,
|
|
235
|
-
type
|
|
233
|
+
type NumberAssociateParams as NumberAssociateParams,
|
|
234
|
+
type NumberDisassociateParams as NumberDisassociateParams,
|
|
236
235
|
};
|
|
237
236
|
}
|
package/src/resources/index.ts
CHANGED
|
@@ -1195,7 +1195,13 @@ export {
|
|
|
1195
1195
|
type TelephonyCredentialsDefaultFlatPagination,
|
|
1196
1196
|
} from './telephony-credentials';
|
|
1197
1197
|
export { TermsOfService } from './terms-of-service/terms-of-service';
|
|
1198
|
-
export {
|
|
1198
|
+
export {
|
|
1199
|
+
Texml,
|
|
1200
|
+
type TexmlInitiateAICallResponse,
|
|
1201
|
+
type TexmlSecretsResponse,
|
|
1202
|
+
type TexmlInitiateAICallParams,
|
|
1203
|
+
type TexmlSecretsParams,
|
|
1204
|
+
} from './texml/texml';
|
|
1199
1205
|
export {
|
|
1200
1206
|
TexmlApplications,
|
|
1201
1207
|
type TexmlApplication,
|
|
@@ -787,6 +787,14 @@ export interface CallCallsParams {
|
|
|
787
787
|
*/
|
|
788
788
|
MachineDetectionTimeout?: number;
|
|
789
789
|
|
|
790
|
+
/**
|
|
791
|
+
* Defines whether media should be encrypted on the call. When set to `SRTP`, the
|
|
792
|
+
* call will use Secure Real-time Transport Protocol for media encryption. When set
|
|
793
|
+
* to `DTLS`, the call will use DTLS for media encryption. Only supported for SIP
|
|
794
|
+
* destinations.
|
|
795
|
+
*/
|
|
796
|
+
MediaEncryption?: 'disabled' | 'SRTP' | 'DTLS';
|
|
797
|
+
|
|
790
798
|
/**
|
|
791
799
|
* The list of comma-separated codecs to be offered on a call.
|
|
792
800
|
*/
|
|
@@ -9,4 +9,10 @@ export {
|
|
|
9
9
|
type AccountRetrieveRecordingsJsonParams,
|
|
10
10
|
type AccountRetrieveTranscriptionsJsonParams,
|
|
11
11
|
} from './accounts/index';
|
|
12
|
-
export {
|
|
12
|
+
export {
|
|
13
|
+
Texml,
|
|
14
|
+
type TexmlInitiateAICallResponse,
|
|
15
|
+
type TexmlSecretsResponse,
|
|
16
|
+
type TexmlInitiateAICallParams,
|
|
17
|
+
type TexmlSecretsParams,
|
|
18
|
+
} from './texml';
|
|
@@ -13,6 +13,7 @@ import {
|
|
|
13
13
|
} from './accounts/accounts';
|
|
14
14
|
import { APIPromise } from '../../core/api-promise';
|
|
15
15
|
import { RequestOptions } from '../../internal/request-options';
|
|
16
|
+
import { path } from '../../internal/utils/path';
|
|
16
17
|
|
|
17
18
|
/**
|
|
18
19
|
* TeXML REST Commands
|
|
@@ -20,6 +21,36 @@ import { RequestOptions } from '../../internal/request-options';
|
|
|
20
21
|
export class Texml extends APIResource {
|
|
21
22
|
accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
|
|
22
23
|
|
|
24
|
+
/**
|
|
25
|
+
* Initiate an outbound AI call with warm-up support. Validates parameters, builds
|
|
26
|
+
* an internal TeXML with an AI Assistant configuration, encodes instructions into
|
|
27
|
+
* client state, and calls the dial API. The Twiml, Texml, and Url parameters are
|
|
28
|
+
* not allowed and will result in a 422 error.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const response = await client.texml.initiateAICall(
|
|
33
|
+
* 'connection_id',
|
|
34
|
+
* {
|
|
35
|
+
* AIAssistantId: 'ai-assistant-id-123',
|
|
36
|
+
* From: '+13120001234',
|
|
37
|
+
* To: '+13121230000',
|
|
38
|
+
* },
|
|
39
|
+
* );
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
initiateAICall(
|
|
43
|
+
connectionID: string,
|
|
44
|
+
params: TexmlInitiateAICallParams,
|
|
45
|
+
options?: RequestOptions,
|
|
46
|
+
): APIPromise<TexmlInitiateAICallResponse> {
|
|
47
|
+
const { timeout_seconds, ...body } = params;
|
|
48
|
+
return this._client.post(path`/texml/ai_calls/${connectionID}`, {
|
|
49
|
+
body: { Timeout: timeout_seconds, ...body },
|
|
50
|
+
...options,
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
|
|
23
54
|
/**
|
|
24
55
|
* Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML
|
|
25
56
|
* when using Mustache Templates in your TeXML. In your TeXML you will be able to
|
|
@@ -40,6 +71,16 @@ export class Texml extends APIResource {
|
|
|
40
71
|
}
|
|
41
72
|
}
|
|
42
73
|
|
|
74
|
+
export interface TexmlInitiateAICallResponse {
|
|
75
|
+
call_sid?: string;
|
|
76
|
+
|
|
77
|
+
from?: string;
|
|
78
|
+
|
|
79
|
+
status?: string;
|
|
80
|
+
|
|
81
|
+
to?: string;
|
|
82
|
+
}
|
|
83
|
+
|
|
43
84
|
export interface TexmlSecretsResponse {
|
|
44
85
|
data?: TexmlSecretsResponse.Data;
|
|
45
86
|
}
|
|
@@ -52,6 +93,238 @@ export namespace TexmlSecretsResponse {
|
|
|
52
93
|
}
|
|
53
94
|
}
|
|
54
95
|
|
|
96
|
+
export interface TexmlInitiateAICallParams {
|
|
97
|
+
/**
|
|
98
|
+
* The ID of the AI assistant to use for the call.
|
|
99
|
+
*/
|
|
100
|
+
AIAssistantId: string;
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* The phone number of the party initiating the call. Phone numbers are formatted
|
|
104
|
+
* with a `+` and country code.
|
|
105
|
+
*/
|
|
106
|
+
From: string;
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* The phone number of the called party. Phone numbers are formatted with a `+` and
|
|
110
|
+
* country code.
|
|
111
|
+
*/
|
|
112
|
+
To: string;
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Key-value map of dynamic variables to pass to the AI assistant.
|
|
116
|
+
*/
|
|
117
|
+
AIAssistantDynamicVariables?: { [key: string]: string };
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* The version of the AI assistant to use.
|
|
121
|
+
*/
|
|
122
|
+
AIAssistantVersion?: string;
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* Select whether to perform answering machine detection in the background. By
|
|
126
|
+
* default execution is blocked until Answering Machine Detection is completed.
|
|
127
|
+
*/
|
|
128
|
+
AsyncAmd?: boolean;
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* URL destination for Telnyx to send AMD callback events to for the call.
|
|
132
|
+
*/
|
|
133
|
+
AsyncAmdStatusCallback?: string;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* HTTP request type used for `AsyncAmdStatusCallback`.
|
|
137
|
+
*/
|
|
138
|
+
AsyncAmdStatusCallbackMethod?: 'GET' | 'POST';
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* To be used as the caller id name (SIP From Display Name) presented to the
|
|
142
|
+
* destination (`To` number). The string should have a maximum of 128 characters,
|
|
143
|
+
* containing only letters, numbers, spaces, and `-_~!.+` special characters. If
|
|
144
|
+
* omitted, the display name will be the same as the number in the `From` field.
|
|
145
|
+
*/
|
|
146
|
+
CallerId?: string;
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* URL destination for Telnyx to send conversation callback events to.
|
|
150
|
+
*/
|
|
151
|
+
ConversationCallback?: string;
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* HTTP request type used for `ConversationCallback`.
|
|
155
|
+
*/
|
|
156
|
+
ConversationCallbackMethod?: 'GET' | 'POST';
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* An array of URL destinations for conversation callback events.
|
|
160
|
+
*/
|
|
161
|
+
ConversationCallbacks?: Array<string>;
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* Custom HTTP headers to be sent with the call. Each header should be an object
|
|
165
|
+
* with 'name' and 'value' properties.
|
|
166
|
+
*/
|
|
167
|
+
CustomHeaders?: Array<TexmlInitiateAICallParams.CustomHeader>;
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Allows you to choose between Premium and Standard detections.
|
|
171
|
+
*/
|
|
172
|
+
DetectionMode?: 'Premium' | 'Regular';
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* Enables Answering Machine Detection.
|
|
176
|
+
*/
|
|
177
|
+
MachineDetection?: 'Enable' | 'Disable' | 'DetectMessageEnd';
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* If initial silence duration is greater than this value, consider it a machine.
|
|
181
|
+
* Ignored when `premium` detection is used.
|
|
182
|
+
*/
|
|
183
|
+
MachineDetectionSilenceTimeout?: number;
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* Silence duration threshold after a greeting message or voice for it be
|
|
187
|
+
* considered human. Ignored when `premium` detection is used.
|
|
188
|
+
*/
|
|
189
|
+
MachineDetectionSpeechEndThreshold?: number;
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* Maximum threshold of a human greeting. If greeting longer than this value,
|
|
193
|
+
* considered machine. Ignored when `premium` detection is used.
|
|
194
|
+
*/
|
|
195
|
+
MachineDetectionSpeechThreshold?: number;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Maximum timeout threshold in milliseconds for overall detection.
|
|
199
|
+
*/
|
|
200
|
+
MachineDetectionTimeout?: number;
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* A string of passport identifiers to associate with the call.
|
|
204
|
+
*/
|
|
205
|
+
Passports?: string;
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* The list of comma-separated codecs to be offered on a call.
|
|
209
|
+
*/
|
|
210
|
+
PreferredCodecs?: string;
|
|
211
|
+
|
|
212
|
+
/**
|
|
213
|
+
* Whether to record the entire participant's call leg. Defaults to `false`.
|
|
214
|
+
*/
|
|
215
|
+
Record?: boolean;
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* The number of channels in the final recording. Defaults to `mono`.
|
|
219
|
+
*/
|
|
220
|
+
RecordingChannels?: 'mono' | 'dual';
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* The URL the recording callbacks will be sent to.
|
|
224
|
+
*/
|
|
225
|
+
RecordingStatusCallback?: string;
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* The changes to the recording's state that should generate a call to
|
|
229
|
+
* `RecordingStatusCallback`. Can be: `in-progress`, `completed` and `absent`.
|
|
230
|
+
* Separate multiple values with a space. Defaults to `completed`.
|
|
231
|
+
*/
|
|
232
|
+
RecordingStatusCallbackEvent?: string;
|
|
233
|
+
|
|
234
|
+
/**
|
|
235
|
+
* HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
|
|
236
|
+
*/
|
|
237
|
+
RecordingStatusCallbackMethod?: 'GET' | 'POST';
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* The number of seconds that Telnyx will wait for the recording to be stopped if
|
|
241
|
+
* silence is detected. The timer only starts when the speech is detected. The
|
|
242
|
+
* minimum value is 0. The default value is 0 (infinite).
|
|
243
|
+
*/
|
|
244
|
+
RecordingTimeout?: number;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* The audio track to record for the call. The default is `both`.
|
|
248
|
+
*/
|
|
249
|
+
RecordingTrack?: 'inbound' | 'outbound' | 'both';
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* Whether to send RecordingUrl in webhooks.
|
|
253
|
+
*/
|
|
254
|
+
SendRecordingUrl?: boolean;
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* The password to use for SIP authentication.
|
|
258
|
+
*/
|
|
259
|
+
SipAuthPassword?: string;
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* The username to use for SIP authentication.
|
|
263
|
+
*/
|
|
264
|
+
SipAuthUsername?: string;
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* Defines the SIP region to be used for the call.
|
|
268
|
+
*/
|
|
269
|
+
SipRegion?: 'US' | 'Europe' | 'Canada' | 'Australia' | 'Middle East';
|
|
270
|
+
|
|
271
|
+
/**
|
|
272
|
+
* URL destination for Telnyx to send status callback events to for the call.
|
|
273
|
+
*/
|
|
274
|
+
StatusCallback?: string;
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* The call events for which Telnyx should send a webhook. Multiple events can be
|
|
278
|
+
* defined when separated by a space. Valid values: initiated, ringing, answered,
|
|
279
|
+
* completed.
|
|
280
|
+
*/
|
|
281
|
+
StatusCallbackEvent?: string;
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* HTTP request type used for `StatusCallback`.
|
|
285
|
+
*/
|
|
286
|
+
StatusCallbackMethod?: 'GET' | 'POST';
|
|
287
|
+
|
|
288
|
+
/**
|
|
289
|
+
* An array of URL destinations for Telnyx to send status callback events to for
|
|
290
|
+
* the call.
|
|
291
|
+
*/
|
|
292
|
+
StatusCallbacks?: Array<string>;
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* The maximum duration of the call in seconds. The minimum value is 30 and the
|
|
296
|
+
* maximum value is 14400 (4 hours). Default is 14400 seconds.
|
|
297
|
+
*/
|
|
298
|
+
TimeLimit?: number;
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* The number of seconds to wait for the called party to answer the call before the
|
|
302
|
+
* call is canceled. The minimum value is 5 and the maximum value is 120. Default
|
|
303
|
+
* is 30 seconds.
|
|
304
|
+
*/
|
|
305
|
+
timeout_seconds?: number;
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Whether to trim any leading and trailing silence from the recording. Defaults to
|
|
309
|
+
* `trim-silence`.
|
|
310
|
+
*/
|
|
311
|
+
Trim?: 'trim-silence' | 'do-not-trim';
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
export namespace TexmlInitiateAICallParams {
|
|
315
|
+
export interface CustomHeader {
|
|
316
|
+
/**
|
|
317
|
+
* The name of the custom header
|
|
318
|
+
*/
|
|
319
|
+
name: string;
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* The value of the custom header
|
|
323
|
+
*/
|
|
324
|
+
value: string;
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
|
|
55
328
|
export interface TexmlSecretsParams {
|
|
56
329
|
/**
|
|
57
330
|
* Name used as a reference for the secret, if the name already exists within the
|
|
@@ -68,7 +341,12 @@ export interface TexmlSecretsParams {
|
|
|
68
341
|
Texml.Accounts = Accounts;
|
|
69
342
|
|
|
70
343
|
export declare namespace Texml {
|
|
71
|
-
export {
|
|
344
|
+
export {
|
|
345
|
+
type TexmlInitiateAICallResponse as TexmlInitiateAICallResponse,
|
|
346
|
+
type TexmlSecretsResponse as TexmlSecretsResponse,
|
|
347
|
+
type TexmlInitiateAICallParams as TexmlInitiateAICallParams,
|
|
348
|
+
type TexmlSecretsParams as TexmlSecretsParams,
|
|
349
|
+
};
|
|
72
350
|
|
|
73
351
|
export {
|
|
74
352
|
Accounts as Accounts,
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.36.0'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "6.
|
|
1
|
+
export declare const VERSION = "6.36.0";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "6.
|
|
1
|
+
export declare const VERSION = "6.36.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '6.
|
|
1
|
+
export const VERSION = '6.36.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|