agentphone 1.0.14 → 1.0.16
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/agents/client/requests/CreateAgentRequest.d.ts +5 -0
- package/dist/cjs/api/resources/agents/client/requests/UpdateAgentRequest.d.ts +5 -0
- package/dist/cjs/api/resources/calls/client/requests/CreateOutboundCallRequest.d.ts +4 -0
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/contacts/client/Client.js +62 -0
- package/dist/cjs/api/resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.d.ts +10 -0
- package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +8 -6
- package/dist/cjs/api/resources/conversations/client/Client.js +8 -6
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationRequest.d.ts +2 -0
- package/dist/cjs/api/resources/messages/client/Client.d.ts +0 -1
- package/dist/cjs/api/resources/messages/client/Client.js +0 -1
- package/dist/cjs/api/resources/messages/client/requests/SendMessageRequest.d.ts +4 -2
- package/dist/cjs/api/resources/registration/client/Client.d.ts +36 -9
- package/dist/cjs/api/resources/registration/client/Client.js +67 -9
- package/dist/cjs/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.d.ts +8 -0
- package/dist/cjs/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.js +3 -0
- package/dist/cjs/api/resources/registration/client/requests/RegistrationRequest.d.ts +52 -30
- package/dist/cjs/api/resources/registration/client/requests/RegistrationRequest.js +9 -0
- package/dist/cjs/api/resources/registration/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/registration/client/requests/index.js +3 -0
- package/dist/cjs/api/resources/subAccounts/client/Client.d.ts +4 -1
- package/dist/cjs/api/resources/subAccounts/client/Client.js +23 -10
- package/dist/cjs/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.d.ts +8 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.js +3 -0
- package/dist/cjs/api/resources/subAccounts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/AgentResponse.d.ts +3 -0
- package/dist/cjs/api/types/CampaignInclude.d.ts +7 -0
- package/dist/cjs/api/types/CampaignInclude.js +10 -0
- package/dist/cjs/api/types/CampaignStatusResponse.d.ts +4 -0
- package/dist/cjs/api/types/CampaignStatusResponse.js +3 -0
- package/dist/cjs/api/types/ContactCapabilitiesResponse.d.ts +6 -0
- package/dist/cjs/api/types/ContactCapabilitiesResponse.js +3 -0
- package/dist/cjs/api/types/ContactCapabilityFlags.d.ts +4 -0
- package/dist/cjs/api/types/ContactCapabilityFlags.js +3 -0
- package/dist/cjs/api/types/ContactTitle.d.ts +11 -0
- package/dist/cjs/api/types/ContactTitle.js +14 -0
- package/dist/cjs/api/types/CustomToolParam.d.ts +28 -0
- package/dist/cjs/api/types/CustomToolParam.js +12 -0
- package/dist/cjs/api/types/MessageInConversation.d.ts +1 -0
- package/dist/cjs/api/types/OrganizationType.d.ts +11 -0
- package/dist/cjs/api/types/OrganizationType.js +14 -0
- package/dist/cjs/api/types/RegistrationResponse.d.ts +2 -3
- package/dist/cjs/api/types/ReplyToInConversation.d.ts +5 -0
- package/dist/cjs/api/types/ReplyToInConversation.js +3 -0
- package/dist/cjs/api/types/SendMessageResponse.d.ts +1 -0
- package/dist/cjs/api/types/UseCase.d.ts +13 -0
- package/dist/cjs/api/types/UseCase.js +16 -0
- package/dist/cjs/api/types/Volume.d.ts +5 -0
- package/dist/cjs/api/types/Volume.js +8 -0
- package/dist/cjs/api/types/index.d.ts +10 -1
- package/dist/cjs/api/types/index.js +10 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/agents/client/requests/CreateAgentRequest.d.mts +5 -0
- package/dist/esm/api/resources/agents/client/requests/UpdateAgentRequest.d.mts +5 -0
- package/dist/esm/api/resources/calls/client/requests/CreateOutboundCallRequest.d.mts +4 -0
- package/dist/esm/api/resources/contacts/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/contacts/client/Client.mjs +62 -0
- package/dist/esm/api/resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.d.mts +10 -0
- package/dist/esm/api/resources/contacts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/client/Client.d.mts +8 -6
- package/dist/esm/api/resources/conversations/client/Client.mjs +8 -6
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationRequest.d.mts +2 -0
- package/dist/esm/api/resources/messages/client/Client.d.mts +0 -1
- package/dist/esm/api/resources/messages/client/Client.mjs +0 -1
- package/dist/esm/api/resources/messages/client/requests/SendMessageRequest.d.mts +4 -2
- package/dist/esm/api/resources/registration/client/Client.d.mts +36 -9
- package/dist/esm/api/resources/registration/client/Client.mjs +68 -10
- package/dist/esm/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.d.mts +8 -0
- package/dist/esm/api/resources/registration/client/requests/GetRegistrationStatusV1RegisterStatusGetRequest.mjs +2 -0
- package/dist/esm/api/resources/registration/client/requests/RegistrationRequest.d.mts +52 -30
- package/dist/esm/api/resources/registration/client/requests/RegistrationRequest.mjs +8 -1
- package/dist/esm/api/resources/registration/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/registration/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/subAccounts/client/Client.d.mts +4 -1
- package/dist/esm/api/resources/subAccounts/client/Client.mjs +23 -10
- package/dist/esm/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.d.mts +8 -0
- package/dist/esm/api/resources/subAccounts/client/requests/ListSubAccountsV1SubAccountsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/subAccounts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/AgentResponse.d.mts +3 -0
- package/dist/esm/api/types/CampaignInclude.d.mts +7 -0
- package/dist/esm/api/types/CampaignInclude.mjs +7 -0
- package/dist/esm/api/types/CampaignStatusResponse.d.mts +4 -0
- package/dist/esm/api/types/CampaignStatusResponse.mjs +2 -0
- package/dist/esm/api/types/ContactCapabilitiesResponse.d.mts +6 -0
- package/dist/esm/api/types/ContactCapabilitiesResponse.mjs +2 -0
- package/dist/esm/api/types/ContactCapabilityFlags.d.mts +4 -0
- package/dist/esm/api/types/ContactCapabilityFlags.mjs +2 -0
- package/dist/esm/api/types/ContactTitle.d.mts +11 -0
- package/dist/esm/api/types/ContactTitle.mjs +11 -0
- package/dist/esm/api/types/CustomToolParam.d.mts +28 -0
- package/dist/esm/api/types/CustomToolParam.mjs +9 -0
- package/dist/esm/api/types/MessageInConversation.d.mts +1 -0
- package/dist/esm/api/types/OrganizationType.d.mts +11 -0
- package/dist/esm/api/types/OrganizationType.mjs +11 -0
- package/dist/esm/api/types/RegistrationResponse.d.mts +2 -3
- package/dist/esm/api/types/ReplyToInConversation.d.mts +5 -0
- package/dist/esm/api/types/ReplyToInConversation.mjs +2 -0
- package/dist/esm/api/types/SendMessageResponse.d.mts +1 -0
- package/dist/esm/api/types/UseCase.d.mts +13 -0
- package/dist/esm/api/types/UseCase.mjs +13 -0
- package/dist/esm/api/types/Volume.d.mts +5 -0
- package/dist/esm/api/types/Volume.mjs +5 -0
- package/dist/esm/api/types/index.d.mts +10 -1
- package/dist/esm/api/types/index.mjs +10 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +175 -17
- package/dist/cjs/api/types/FieldWarning.d.ts +0 -6
- package/dist/esm/api/types/FieldWarning.d.mts +0 -6
- /package/dist/cjs/api/{types/FieldWarning.js → resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.js} +0 -0
- /package/dist/esm/api/{types/FieldWarning.mjs → resources/contacts/client/requests/GetContactCapabilitiesV1ContactsCapabilitiesGetRequest.mjs} +0 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export interface CustomToolParam {
|
|
2
|
+
/** Function name the agent calls. Letters, numbers, underscores, hyphens; max 64 chars. Must be unique and not a reserved built-in name. */
|
|
3
|
+
name: string;
|
|
4
|
+
/** What the tool does and when to use it. The agent relies on this to decide when to call it. */
|
|
5
|
+
description: string;
|
|
6
|
+
/** HTTPS endpoint the voice provider calls when the agent invokes this tool. */
|
|
7
|
+
url: string;
|
|
8
|
+
/** HTTP method. Defaults to POST. */
|
|
9
|
+
method?: CustomToolParam.Method;
|
|
10
|
+
/** Optional HTTP headers sent with the request (e.g. an Authorization token for your endpoint). */
|
|
11
|
+
headers?: Record<string, string | null> | null;
|
|
12
|
+
/** JSON Schema object describing the arguments the agent fills in. Omit for a no-argument tool. */
|
|
13
|
+
parameters?: Record<string, unknown> | null;
|
|
14
|
+
/** How long to wait for your endpoint before giving up. Range 1000-120000 ms. */
|
|
15
|
+
timeoutMs?: number | null;
|
|
16
|
+
/** When true, the agent speaks executionMessage while the tool runs. */
|
|
17
|
+
speakDuringExecution?: boolean | null;
|
|
18
|
+
/** What the agent says while the tool runs (used when speakDuringExecution is true). */
|
|
19
|
+
executionMessage?: string | null;
|
|
20
|
+
}
|
|
21
|
+
export declare namespace CustomToolParam {
|
|
22
|
+
/** HTTP method. Defaults to POST. */
|
|
23
|
+
const Method: {
|
|
24
|
+
readonly Get: "GET";
|
|
25
|
+
readonly Post: "POST";
|
|
26
|
+
};
|
|
27
|
+
type Method = (typeof Method)[keyof typeof Method];
|
|
28
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var CustomToolParam;
|
|
3
|
+
(function (CustomToolParam) {
|
|
4
|
+
/** HTTP method. Defaults to POST. */
|
|
5
|
+
CustomToolParam.Method = {
|
|
6
|
+
Get: "GET",
|
|
7
|
+
Post: "POST",
|
|
8
|
+
};
|
|
9
|
+
})(CustomToolParam || (CustomToolParam = {}));
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export declare const OrganizationType: {
|
|
2
|
+
readonly SoleProprietor: "sole_proprietor";
|
|
3
|
+
readonly PrivateCorporation: "private_corporation";
|
|
4
|
+
readonly PublicCorporation: "public_corporation";
|
|
5
|
+
readonly Llc: "llc";
|
|
6
|
+
readonly Partnership: "partnership";
|
|
7
|
+
readonly NonProfit: "non_profit";
|
|
8
|
+
readonly CoOp: "co_op";
|
|
9
|
+
readonly Government: "government";
|
|
10
|
+
};
|
|
11
|
+
export type OrganizationType = (typeof OrganizationType)[keyof typeof OrganizationType];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export const OrganizationType = {
|
|
3
|
+
SoleProprietor: "sole_proprietor",
|
|
4
|
+
PrivateCorporation: "private_corporation",
|
|
5
|
+
PublicCorporation: "public_corporation",
|
|
6
|
+
Llc: "llc",
|
|
7
|
+
Partnership: "partnership",
|
|
8
|
+
NonProfit: "non_profit",
|
|
9
|
+
CoOp: "co_op",
|
|
10
|
+
Government: "government",
|
|
11
|
+
};
|
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
import type * as AgentPhone from "../index.mjs";
|
|
2
1
|
export interface RegistrationResponse {
|
|
3
2
|
ok: boolean;
|
|
4
3
|
message: string;
|
|
5
|
-
payment_url: string;
|
|
6
4
|
campaign_status: string;
|
|
7
|
-
|
|
5
|
+
sub_account_id?: string | null;
|
|
6
|
+
fee_cents?: number;
|
|
8
7
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export declare const UseCase: {
|
|
2
|
+
readonly AccountNotification: "account_notification";
|
|
3
|
+
readonly CustomerCare: "customer_care";
|
|
4
|
+
readonly DeliveryNotification: "delivery_notification";
|
|
5
|
+
readonly FraudAlert: "fraud_alert";
|
|
6
|
+
readonly HigherEducation: "higher_education";
|
|
7
|
+
readonly Marketing: "marketing";
|
|
8
|
+
readonly PollingVoting: "polling_voting";
|
|
9
|
+
readonly PublicServiceAnnouncement: "public_service_announcement";
|
|
10
|
+
readonly SecurityAlert: "security_alert";
|
|
11
|
+
readonly TwoFactorAuthentication: "two_factor_authentication";
|
|
12
|
+
};
|
|
13
|
+
export type UseCase = (typeof UseCase)[keyof typeof UseCase];
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export const UseCase = {
|
|
3
|
+
AccountNotification: "account_notification",
|
|
4
|
+
CustomerCare: "customer_care",
|
|
5
|
+
DeliveryNotification: "delivery_notification",
|
|
6
|
+
FraudAlert: "fraud_alert",
|
|
7
|
+
HigherEducation: "higher_education",
|
|
8
|
+
Marketing: "marketing",
|
|
9
|
+
PollingVoting: "polling_voting",
|
|
10
|
+
PublicServiceAnnouncement: "public_service_announcement",
|
|
11
|
+
SecurityAlert: "security_alert",
|
|
12
|
+
TwoFactorAuthentication: "two_factor_authentication",
|
|
13
|
+
};
|
|
@@ -13,14 +13,19 @@ export * from "./AppRoutesConversationsConversationSummary.mjs";
|
|
|
13
13
|
export * from "./AttachNumberResponse.mjs";
|
|
14
14
|
export * from "./CallListResponse.mjs";
|
|
15
15
|
export * from "./CallSummary.mjs";
|
|
16
|
+
export * from "./CampaignInclude.mjs";
|
|
17
|
+
export * from "./CampaignStatusResponse.mjs";
|
|
18
|
+
export * from "./ContactCapabilitiesResponse.mjs";
|
|
19
|
+
export * from "./ContactCapabilityFlags.mjs";
|
|
16
20
|
export * from "./ContactCardResponse.mjs";
|
|
17
21
|
export * from "./ContactListResponse.mjs";
|
|
18
22
|
export * from "./ContactResponse.mjs";
|
|
23
|
+
export * from "./ContactTitle.mjs";
|
|
19
24
|
export * from "./ConversationDetail.mjs";
|
|
25
|
+
export * from "./CustomToolParam.mjs";
|
|
20
26
|
export * from "./DailyUsagePoint.mjs";
|
|
21
27
|
export * from "./DailyUsageResponse.mjs";
|
|
22
28
|
export * from "./DeleteAgentResponse.mjs";
|
|
23
|
-
export * from "./FieldWarning.mjs";
|
|
24
29
|
export * from "./GroupParticipant.mjs";
|
|
25
30
|
export * from "./HttpValidationError.mjs";
|
|
26
31
|
export * from "./LocationRefreshResponse.mjs";
|
|
@@ -34,6 +39,7 @@ export * from "./MonthlyUsageResponse.mjs";
|
|
|
34
39
|
export * from "./NumberLimits.mjs";
|
|
35
40
|
export * from "./NumberUsageItem.mjs";
|
|
36
41
|
export * from "./NumberUsageResponse.mjs";
|
|
42
|
+
export * from "./OrganizationType.mjs";
|
|
37
43
|
export * from "./PaginatedDeliveriesResponse.mjs";
|
|
38
44
|
export * from "./PhoneNumberListResponse.mjs";
|
|
39
45
|
export * from "./PhoneNumberResponse.mjs";
|
|
@@ -41,13 +47,16 @@ export * from "./PlanInfo.mjs";
|
|
|
41
47
|
export * from "./PlanLimits.mjs";
|
|
42
48
|
export * from "./ReactionInConversation.mjs";
|
|
43
49
|
export * from "./RegistrationResponse.mjs";
|
|
50
|
+
export * from "./ReplyToInConversation.mjs";
|
|
44
51
|
export * from "./SendMessageResponse.mjs";
|
|
45
52
|
export * from "./SendReactionResponse.mjs";
|
|
46
53
|
export * from "./SendTypingResponse.mjs";
|
|
47
54
|
export * from "./SetBackgroundResponse.mjs";
|
|
48
55
|
export * from "./UsageResponse.mjs";
|
|
49
56
|
export * from "./UsageStats.mjs";
|
|
57
|
+
export * from "./UseCase.mjs";
|
|
50
58
|
export * from "./ValidationError.mjs";
|
|
59
|
+
export * from "./Volume.mjs";
|
|
51
60
|
export * from "./WebhookCreateRequest.mjs";
|
|
52
61
|
export * from "./WebhookDeliveryResponse.mjs";
|
|
53
62
|
export * from "./WebhookDeliveryStatsResponse.mjs";
|
|
@@ -13,14 +13,19 @@ export * from "./AppRoutesConversationsConversationSummary.mjs";
|
|
|
13
13
|
export * from "./AttachNumberResponse.mjs";
|
|
14
14
|
export * from "./CallListResponse.mjs";
|
|
15
15
|
export * from "./CallSummary.mjs";
|
|
16
|
+
export * from "./CampaignInclude.mjs";
|
|
17
|
+
export * from "./CampaignStatusResponse.mjs";
|
|
18
|
+
export * from "./ContactCapabilitiesResponse.mjs";
|
|
19
|
+
export * from "./ContactCapabilityFlags.mjs";
|
|
16
20
|
export * from "./ContactCardResponse.mjs";
|
|
17
21
|
export * from "./ContactListResponse.mjs";
|
|
18
22
|
export * from "./ContactResponse.mjs";
|
|
23
|
+
export * from "./ContactTitle.mjs";
|
|
19
24
|
export * from "./ConversationDetail.mjs";
|
|
25
|
+
export * from "./CustomToolParam.mjs";
|
|
20
26
|
export * from "./DailyUsagePoint.mjs";
|
|
21
27
|
export * from "./DailyUsageResponse.mjs";
|
|
22
28
|
export * from "./DeleteAgentResponse.mjs";
|
|
23
|
-
export * from "./FieldWarning.mjs";
|
|
24
29
|
export * from "./GroupParticipant.mjs";
|
|
25
30
|
export * from "./HttpValidationError.mjs";
|
|
26
31
|
export * from "./LocationRefreshResponse.mjs";
|
|
@@ -34,6 +39,7 @@ export * from "./MonthlyUsageResponse.mjs";
|
|
|
34
39
|
export * from "./NumberLimits.mjs";
|
|
35
40
|
export * from "./NumberUsageItem.mjs";
|
|
36
41
|
export * from "./NumberUsageResponse.mjs";
|
|
42
|
+
export * from "./OrganizationType.mjs";
|
|
37
43
|
export * from "./PaginatedDeliveriesResponse.mjs";
|
|
38
44
|
export * from "./PhoneNumberListResponse.mjs";
|
|
39
45
|
export * from "./PhoneNumberResponse.mjs";
|
|
@@ -41,13 +47,16 @@ export * from "./PlanInfo.mjs";
|
|
|
41
47
|
export * from "./PlanLimits.mjs";
|
|
42
48
|
export * from "./ReactionInConversation.mjs";
|
|
43
49
|
export * from "./RegistrationResponse.mjs";
|
|
50
|
+
export * from "./ReplyToInConversation.mjs";
|
|
44
51
|
export * from "./SendMessageResponse.mjs";
|
|
45
52
|
export * from "./SendReactionResponse.mjs";
|
|
46
53
|
export * from "./SendTypingResponse.mjs";
|
|
47
54
|
export * from "./SetBackgroundResponse.mjs";
|
|
48
55
|
export * from "./UsageResponse.mjs";
|
|
49
56
|
export * from "./UsageStats.mjs";
|
|
57
|
+
export * from "./UseCase.mjs";
|
|
50
58
|
export * from "./ValidationError.mjs";
|
|
59
|
+
export * from "./Volume.mjs";
|
|
51
60
|
export * from "./WebhookCreateRequest.mjs";
|
|
52
61
|
export * from "./WebhookDeliveryResponse.mjs";
|
|
53
62
|
export * from "./WebhookDeliveryStatsResponse.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.0.
|
|
1
|
+
export declare const SDK_VERSION = "1.0.16";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.0.
|
|
1
|
+
export const SDK_VERSION = "1.0.16";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1902,6 +1902,76 @@ await client.contacts.createContact({
|
|
|
1902
1902
|
</dl>
|
|
1903
1903
|
|
|
1904
1904
|
|
|
1905
|
+
</dd>
|
|
1906
|
+
</dl>
|
|
1907
|
+
</details>
|
|
1908
|
+
|
|
1909
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">getContactCapabilities</a>({ ...params }) -> AgentPhone.ContactCapabilitiesResponse</code></summary>
|
|
1910
|
+
<dl>
|
|
1911
|
+
<dd>
|
|
1912
|
+
|
|
1913
|
+
#### 📝 Description
|
|
1914
|
+
|
|
1915
|
+
<dl>
|
|
1916
|
+
<dd>
|
|
1917
|
+
|
|
1918
|
+
<dl>
|
|
1919
|
+
<dd>
|
|
1920
|
+
|
|
1921
|
+
Check which messaging channels a phone number supports, without sending
|
|
1922
|
+
a message.
|
|
1923
|
+
|
|
1924
|
+
Runs a live check (typically 1-2 seconds), so the result reflects the
|
|
1925
|
+
number right now. Capabilities can still change by the time you send.
|
|
1926
|
+
Requires at least one active iMessage-capable number on the account.
|
|
1927
|
+
</dd>
|
|
1928
|
+
</dl>
|
|
1929
|
+
</dd>
|
|
1930
|
+
</dl>
|
|
1931
|
+
|
|
1932
|
+
#### 🔌 Usage
|
|
1933
|
+
|
|
1934
|
+
<dl>
|
|
1935
|
+
<dd>
|
|
1936
|
+
|
|
1937
|
+
<dl>
|
|
1938
|
+
<dd>
|
|
1939
|
+
|
|
1940
|
+
```typescript
|
|
1941
|
+
await client.contacts.getContactCapabilities({
|
|
1942
|
+
phone_number: "phone_number"
|
|
1943
|
+
});
|
|
1944
|
+
|
|
1945
|
+
```
|
|
1946
|
+
</dd>
|
|
1947
|
+
</dl>
|
|
1948
|
+
</dd>
|
|
1949
|
+
</dl>
|
|
1950
|
+
|
|
1951
|
+
#### ⚙️ Parameters
|
|
1952
|
+
|
|
1953
|
+
<dl>
|
|
1954
|
+
<dd>
|
|
1955
|
+
|
|
1956
|
+
<dl>
|
|
1957
|
+
<dd>
|
|
1958
|
+
|
|
1959
|
+
**request:** `AgentPhone.GetContactCapabilitiesV1ContactsCapabilitiesGetRequest`
|
|
1960
|
+
|
|
1961
|
+
</dd>
|
|
1962
|
+
</dl>
|
|
1963
|
+
|
|
1964
|
+
<dl>
|
|
1965
|
+
<dd>
|
|
1966
|
+
|
|
1967
|
+
**requestOptions:** `ContactsClient.RequestOptions`
|
|
1968
|
+
|
|
1969
|
+
</dd>
|
|
1970
|
+
</dl>
|
|
1971
|
+
</dd>
|
|
1972
|
+
</dl>
|
|
1973
|
+
|
|
1974
|
+
|
|
1905
1975
|
</dd>
|
|
1906
1976
|
</dl>
|
|
1907
1977
|
</details>
|
|
@@ -2247,14 +2317,16 @@ await client.conversations.getConversation({
|
|
|
2247
2317
|
<dl>
|
|
2248
2318
|
<dd>
|
|
2249
2319
|
|
|
2250
|
-
Update conversation
|
|
2320
|
+
Update a conversation.
|
|
2251
2321
|
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
-
|
|
2322
|
+
- `metadata`: store custom context for AI agents (customer info, order/ticket
|
|
2323
|
+
ids, session state). Replaces the stored object; surfaced in webhook
|
|
2324
|
+
payloads as `conversationState`.
|
|
2325
|
+
- `group_name`: rename a group conversation (iMessage groups only). Also
|
|
2326
|
+
renames the underlying iMessage thread.
|
|
2256
2327
|
|
|
2257
|
-
|
|
2328
|
+
Only the fields you include are changed: a rename-only PATCH leaves metadata
|
|
2329
|
+
untouched, and vice versa.
|
|
2258
2330
|
</dd>
|
|
2259
2331
|
</dl>
|
|
2260
2332
|
</dd>
|
|
@@ -3575,7 +3647,6 @@ To send a carousel of images on iMessage, pass 2-20 URLs in `media_urls`. Requir
|
|
|
3575
3647
|
|
|
3576
3648
|
```typescript
|
|
3577
3649
|
await client.messages.sendMessage({
|
|
3578
|
-
to_number: "to_number",
|
|
3579
3650
|
body: "body"
|
|
3580
3651
|
});
|
|
3581
3652
|
|
|
@@ -3880,6 +3951,79 @@ await client.contactCards.deleteContactCard({
|
|
|
3880
3951
|
</details>
|
|
3881
3952
|
|
|
3882
3953
|
## Registration
|
|
3954
|
+
<details><summary><code>client.registration.<a href="/src/api/resources/registration/client/Client.ts">getRegistrationStatus</a>({ ...params }) -> AgentPhone.CampaignStatusResponse</code></summary>
|
|
3955
|
+
<dl>
|
|
3956
|
+
<dd>
|
|
3957
|
+
|
|
3958
|
+
#### 📝 Description
|
|
3959
|
+
|
|
3960
|
+
<dl>
|
|
3961
|
+
<dd>
|
|
3962
|
+
|
|
3963
|
+
<dl>
|
|
3964
|
+
<dd>
|
|
3965
|
+
|
|
3966
|
+
Check the status of your A2P 10DLC registration.
|
|
3967
|
+
|
|
3968
|
+
### Sub-account status
|
|
3969
|
+
|
|
3970
|
+
To check the registration status of a sub-account, pass the `X-Sub-Account-Id` header with the sub-account ID returned from `POST /v1/register`.
|
|
3971
|
+
|
|
3972
|
+
### Possible statuses
|
|
3973
|
+
|
|
3974
|
+
- `none` -- No registration submitted.
|
|
3975
|
+
- `pending` -- Registration is under review.
|
|
3976
|
+
- `approved` -- Registration approved. Your account is ready to send messages.
|
|
3977
|
+
</dd>
|
|
3978
|
+
</dl>
|
|
3979
|
+
</dd>
|
|
3980
|
+
</dl>
|
|
3981
|
+
|
|
3982
|
+
#### 🔌 Usage
|
|
3983
|
+
|
|
3984
|
+
<dl>
|
|
3985
|
+
<dd>
|
|
3986
|
+
|
|
3987
|
+
<dl>
|
|
3988
|
+
<dd>
|
|
3989
|
+
|
|
3990
|
+
```typescript
|
|
3991
|
+
await client.registration.getRegistrationStatus();
|
|
3992
|
+
|
|
3993
|
+
```
|
|
3994
|
+
</dd>
|
|
3995
|
+
</dl>
|
|
3996
|
+
</dd>
|
|
3997
|
+
</dl>
|
|
3998
|
+
|
|
3999
|
+
#### ⚙️ Parameters
|
|
4000
|
+
|
|
4001
|
+
<dl>
|
|
4002
|
+
<dd>
|
|
4003
|
+
|
|
4004
|
+
<dl>
|
|
4005
|
+
<dd>
|
|
4006
|
+
|
|
4007
|
+
**request:** `AgentPhone.GetRegistrationStatusV1RegisterStatusGetRequest`
|
|
4008
|
+
|
|
4009
|
+
</dd>
|
|
4010
|
+
</dl>
|
|
4011
|
+
|
|
4012
|
+
<dl>
|
|
4013
|
+
<dd>
|
|
4014
|
+
|
|
4015
|
+
**requestOptions:** `RegistrationClient.RequestOptions`
|
|
4016
|
+
|
|
4017
|
+
</dd>
|
|
4018
|
+
</dl>
|
|
4019
|
+
</dd>
|
|
4020
|
+
</dl>
|
|
4021
|
+
|
|
4022
|
+
|
|
4023
|
+
</dd>
|
|
4024
|
+
</dl>
|
|
4025
|
+
</details>
|
|
4026
|
+
|
|
3883
4027
|
<details><summary><code>client.registration.<a href="/src/api/resources/registration/client/Client.ts">registerA2P</a>({ ...params }) -> AgentPhone.RegistrationResponse</code></summary>
|
|
3884
4028
|
<dl>
|
|
3885
4029
|
<dd>
|
|
@@ -3899,15 +4043,18 @@ US carriers require 10DLC registration before your AI agent can send text messag
|
|
|
3899
4043
|
### How it works
|
|
3900
4044
|
|
|
3901
4045
|
1. Submit your registration details via this endpoint
|
|
3902
|
-
2.
|
|
3903
|
-
3.
|
|
3904
|
-
4.
|
|
3905
|
-
5. Carrier approval typically takes 7-10 business days
|
|
4046
|
+
2. A one-time $25 registration fee is deducted from your account balance
|
|
4047
|
+
3. We submit your registration to the carriers on your behalf
|
|
4048
|
+
4. Carrier approval typically takes 7-10 business days
|
|
3906
4049
|
|
|
3907
4050
|
### Registration types
|
|
3908
4051
|
|
|
3909
|
-
- **`sole_proprietor`**
|
|
3910
|
-
- **`standard_brand`**
|
|
4052
|
+
- **`sole_proprietor`** -- For individuals or small businesses. Simpler requirements, fewer fields.
|
|
4053
|
+
- **`standard_brand`** -- For established businesses. Requires `business_name`, `organization_type`, `ein`, `privacy_policy_url`, `terms_of_service_url`.
|
|
4054
|
+
|
|
4055
|
+
### Sub-accounts
|
|
4056
|
+
|
|
4057
|
+
Parent accounts can set `create_sub_account: true` (the default) to create a dedicated sub-account for each registration. This lets you manage multiple campaigns independently. The $25 fee is always charged to the parent account.
|
|
3911
4058
|
|
|
3912
4059
|
### Opt-in image
|
|
3913
4060
|
|
|
@@ -3915,7 +4062,7 @@ US carriers require 10DLC registration before your AI agent can send text messag
|
|
|
3915
4062
|
|
|
3916
4063
|
### Re-submitting
|
|
3917
4064
|
|
|
3918
|
-
If
|
|
4065
|
+
If your previous registration was rejected, you can call this endpoint again to re-register.
|
|
3919
4066
|
</dd>
|
|
3920
4067
|
</dl>
|
|
3921
4068
|
</dd>
|
|
@@ -3931,7 +4078,7 @@ If you've already submitted but haven't completed payment, calling this endpoint
|
|
|
3931
4078
|
|
|
3932
4079
|
```typescript
|
|
3933
4080
|
await client.registration.registerA2P({
|
|
3934
|
-
registration_type: "
|
|
4081
|
+
registration_type: "sole_proprietor",
|
|
3935
4082
|
first_name: "first_name",
|
|
3936
4083
|
last_name: "last_name",
|
|
3937
4084
|
email: "email",
|
|
@@ -3940,7 +4087,10 @@ await client.registration.registerA2P({
|
|
|
3940
4087
|
city: "city",
|
|
3941
4088
|
state: "state",
|
|
3942
4089
|
zip_code: "zip_code",
|
|
3943
|
-
|
|
4090
|
+
description: "description",
|
|
4091
|
+
use_cases: ["account_notification"],
|
|
4092
|
+
message_samples: ["message_samples"],
|
|
4093
|
+
consent_flow: "consent_flow",
|
|
3944
4094
|
opt_in_image_url: "opt_in_image_url"
|
|
3945
4095
|
});
|
|
3946
4096
|
|
|
@@ -3979,7 +4129,7 @@ await client.registration.registerA2P({
|
|
|
3979
4129
|
</details>
|
|
3980
4130
|
|
|
3981
4131
|
## SubAccounts
|
|
3982
|
-
<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">listSubAccounts</a>() -> unknown</code></summary>
|
|
4132
|
+
<details><summary><code>client.subAccounts.<a href="/src/api/resources/subAccounts/client/Client.ts">listSubAccounts</a>({ ...params }) -> unknown</code></summary>
|
|
3983
4133
|
<dl>
|
|
3984
4134
|
<dd>
|
|
3985
4135
|
|
|
@@ -4008,6 +4158,14 @@ await client.subAccounts.listSubAccounts();
|
|
|
4008
4158
|
<dl>
|
|
4009
4159
|
<dd>
|
|
4010
4160
|
|
|
4161
|
+
**request:** `AgentPhone.ListSubAccountsV1SubAccountsGetRequest`
|
|
4162
|
+
|
|
4163
|
+
</dd>
|
|
4164
|
+
</dl>
|
|
4165
|
+
|
|
4166
|
+
<dl>
|
|
4167
|
+
<dd>
|
|
4168
|
+
|
|
4011
4169
|
**requestOptions:** `SubAccountsClient.RequestOptions`
|
|
4012
4170
|
|
|
4013
4171
|
</dd>
|
|
File without changes
|