telnyx-10dlc-curl

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx 10DLC - curl

Installation

安装

text

undefined

text

undefined

curl is pre-installed on macOS, Linux, and Windows 10+

undefined

undefined

Setup

配置

bash

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

All examples below use

$TELNYX_API_KEY

for authentication.

bash

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

下方所有示例均使用

$TELNYX_API_KEY

进行身份验证。

Error Handling

错误处理

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "ABC Mobile",
  "country": "US",
  "email": "support@example.com",
  "vertical": "TECHNOLOGY"
}' \
  "https://api.telnyx.com/v2/10dlc/brand"

Common error codes:

invalid API key,

insufficient permissions,

resource not found,

validation error (check field formats),

rate limited (retry with exponential backoff).

所有API调用都可能因网络错误、速率限制(429)、校验错误(422)或身份验证错误(401)而失败。在生产代码中请始终做好错误处理：

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "ABC Mobile",
  "country": "US",
  "email": "support@example.com",
  "vertical": "TECHNOLOGY"
}' \
  "https://api.telnyx.com/v2/10dlc/brand"

常见错误码：

API密钥无效，

权限不足，

资源未找到，

校验错误（请检查字段格式），

触发速率限制（请使用指数退避策略重试）。

Important Notes

重要说明

Pagination: List endpoints return paginated results. Use
```
page[number]
```
and
```
page[size]
```
query parameters to navigate pages. Check
```
meta.total_pages
```
in the response.

分页： 列表接口返回分页结果。使用
```
page[number]
```
和
```
page[size]
```
查询参数来翻页，可查看响应中的
```
meta.total_pages
```
获取总页数。

Operational Caveats

操作注意事项

10DLC is sequential: create the brand first, then submit the campaign, then attach messaging infrastructure such as the messaging profile.
Registration calls are not enough by themselves. Messaging cannot use the campaign until the assignment step completes successfully.
Treat registration status fields as part of the control flow. Do not assume the campaign is send-ready until the returned status fields confirm it.

10DLC操作需按顺序执行：先创建品牌，再提交活动，最后关联消息配置文件等消息基础设施。
仅完成注册调用是不够的，只有分配步骤成功完成后，短信服务才能使用该活动。
请将注册状态字段作为控制流程的依据，在返回的状态字段确认活动可发送之前，不要假定活动已就绪。

Reference Use Rules

参考使用规则

Do not invent Telnyx parameters, enums, response fields, or webhook fields.

If the parameter, enum, or response field you need is not shown inline in this skill, read references/api-details.md before writing code.
Before using any operation in
```
## Additional Operations
```
, read the optional-parameters section and the response-schemas section.
Before reading or matching webhook fields beyond the inline examples, read the webhook payload reference.

请勿自行定义Telnyx参数、枚举值、响应字段或webhook字段。

如果你需要的参数、枚举值或响应字段未在本技能中直接展示，请在编写代码前阅读references/api-details.md。
在使用
```
## 额外操作
```
中的任何接口前，请阅读可选参数章节和响应模式章节。
在读取或匹配内联示例之外的webhook字段前，请阅读webhook payload参考。

Core Tasks

核心任务

Create a brand

创建品牌

Brand registration is the entrypoint for any US A2P 10DLC campaign flow.

POST /10dlc/brand

Parameter	Type	Required	Description
`entityType`	object	Yes	Entity type behind the brand.
`displayName`	string	Yes	Display name, marketing name, or DBA name of the brand.
`country`	string	Yes	ISO2 2 characters country code.
`email`	string	Yes	Valid email address of brand support contact.
`vertical`	object	Yes	Vertical or industry segment of the brand.
`companyName`	string	No	(Required for Non-profit/private/public) Legal company name.
`firstName`	string	No	First name of business contact.
`lastName`	string	No	Last name of business contact.
...			+16 optional params in references/api-details.md

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "ABC Mobile",
  "country": "US",
  "email": "support@example.com",
  "vertical": "TECHNOLOGY"
}' \
  "https://api.telnyx.com/v2/10dlc/brand"

Primary response fields:

```
.data.brandId
```
```
.data.identityStatus
```
```
.data.status
```
```
.data.displayName
```
```
.data.state
```
```
.data.altBusinessId
```

品牌注册是所有美国A2P 10DLC活动流程的入口。

POST /10dlc/brand

参数	类型	必填	描述
`entityType`	object	是	品牌所属的实体类型。
`displayName`	string	是	品牌的展示名称、营销名称或经营名称。
`country`	string	是	ISO2两位国家代码。
`email`	string	是	品牌支持联系人的有效邮箱地址。
`vertical`	object	是	品牌所属的垂直领域或行业细分。
`companyName`	string	否	（非营利/私营/公立实体必填）合法公司名称。
`firstName`	string	否	业务联系人的名。
`lastName`	string	否	业务联系人的姓。
...			另有16个可选参数，详见references/api-details.md

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "ABC Mobile",
  "country": "US",
  "email": "support@example.com",
  "vertical": "TECHNOLOGY"
}' \
  "https://api.telnyx.com/v2/10dlc/brand"

主要响应字段：

```
.data.brandId
```
```
.data.identityStatus
```
```
.data.status
```
```
.data.displayName
```
```
.data.state
```
```
.data.altBusinessId
```

Submit a campaign

提交活动

Campaign submission is the compliance-critical step that determines whether traffic can be provisioned.

POST /10dlc/campaignBuilder

Parameter	Type	Required	Description
`brandId`	string (UUID)	Yes	Alphanumeric identifier of the brand associated with this ca...
`description`	string	Yes	Summary description of this campaign.
`usecase`	string	Yes	Campaign usecase.
`ageGated`	boolean	No	Age gated message content in campaign.
`autoRenewal`	boolean	No	Campaign subscription auto-renewal option.
`directLending`	boolean	No	Direct lending or loan arrangement
...			+29 optional params in references/api-details.md

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "brandId": "BXXX001",
      "description": "Two-factor authentication messages",
      "usecase": "2FA",
      "sample_messages": [
          "Your verification code is {{code}}"
      ]
  }' \
  "https://api.telnyx.com/v2/10dlc/campaignBuilder"

Primary response fields:

```
.data.campaignId
```
```
.data.brandId
```
```
.data.campaignStatus
```
```
.data.submissionStatus
```
```
.data.failureReasons
```
```
.data.status
```

活动提交是决定流量是否可以开通的核心合规步骤。

POST /10dlc/campaignBuilder

参数	类型	必填	描述
`brandId`	string (UUID)	是	与该活动关联的品牌的字母数字标识符。
`description`	string	是	该活动的概要描述。
`usecase`	string	是	活动用例。
`ageGated`	boolean	否	活动中的消息内容是否有年龄限制。
`autoRenewal`	boolean	否	活动订阅自动续费选项。
`directLending`	boolean	否	是否为直接放贷或贷款安排相关内容
...			另有29个可选参数，详见references/api-details.md

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "brandId": "BXXX001",
      "description": "Two-factor authentication messages",
      "usecase": "2FA",
      "sample_messages": [
          "Your verification code is {{code}}"
      ]
  }' \
  "https://api.telnyx.com/v2/10dlc/campaignBuilder"

主要响应字段：

```
.data.campaignId
```
```
.data.brandId
```
```
.data.campaignStatus
```
```
.data.submissionStatus
```
```
.data.failureReasons
```
```
.data.status
```

Assign a messaging profile to a campaign

为活动分配消息配置文件

Messaging profile assignment is the practical handoff from registration to send-ready messaging infrastructure.

POST /10dlc/phoneNumberAssignmentByProfile

Parameter	Type	Required	Description
`messagingProfileId`	string (UUID)	Yes	The ID of the messaging profile that you want to link to the...
`campaignId`	string (UUID)	Yes	The ID of the campaign you want to link to the specified mes...
`tcrCampaignId`	string (UUID)	No	The TCR ID of the shared campaign you want to link to the sp...

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "messagingProfileId": "4001767e-ce0f-4cae-9d5f-0d5e636e7809",
      "campaignId": "CXXX001"
  }' \
  "https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile"

Primary response fields:

```
.data.messagingProfileId
```
```
.data.campaignId
```
```
.data.taskId
```
```
.data.tcrCampaignId
```

消息配置文件分配是从注册到消息发送就绪的实际交接步骤。

POST /10dlc/phoneNumberAssignmentByProfile

参数	类型	必填	描述
`messagingProfileId`	string (UUID)	是	你想要关联到指定活动的消息配置文件ID。
`campaignId`	string (UUID)	是	你想要关联到指定消息配置文件的活动ID。
`tcrCampaignId`	string (UUID)	否	你想要关联到指定消息配置文件的共享活动的TCR ID。

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "messagingProfileId": "4001767e-ce0f-4cae-9d5f-0d5e636e7809",
      "campaignId": "CXXX001"
  }' \
  "https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile"

主要响应字段：

```
.data.messagingProfileId
```
```
.data.campaignId
```
```
.data.taskId
```
```
.data.tcrCampaignId
```

Webhook Verification

Webhook验证

Telnyx signs webhooks with Ed25519. Each request includes

telnyx-signature-ed25519

and

telnyx-timestamp

headers. Always verify signatures in production:

bash

undefined

Telnyx使用Ed25519对webhook进行签名。每个请求都包含

telnyx-signature-ed25519

和

telnyx-timestamp

请求头。在生产环境中请始终验证签名：

bash

undefined

Telnyx signs webhooks with Ed25519 (asymmetric — NOT HMAC/Standard Webhooks).

Headers sent with each webhook:

telnyx-signature-ed25519: base64-encoded Ed25519 signature

telnyx-timestamp: Unix timestamp (reject if >5 minutes old for replay protection)

Get your public key from: Telnyx Portal > Account Settings > Keys & Credentials

Use the Telnyx SDK in your language for verification (client.webhooks.unwrap).

Your endpoint MUST return 2xx within 2 seconds or Telnyx will retry (up to 3 attempts).

Configure a failover URL in Telnyx Portal for additional reliability.

undefined

undefined

Webhooks

These webhook payload fields are inline because they are part of the primary integration path.

以下webhook payload字段为核心集成路径的一部分，因此直接展示在此处。

Campaign Status Update

活动状态更新

Field	Type	Description
`brandId`	string	Brand ID associated with the campaign.
`campaignId`	string	The ID of the campaign.
`createDate`	string	Unix timestamp when campaign was created.
`cspId`	string	Alphanumeric identifier of the CSP associated with this campaign.
`isTMobileRegistered`	boolean	Indicates whether the campaign is registered with T-Mobile.
`type`	enum: TELNYX_EVENT, REGISTRATION, MNO_REVIEW, TELNYX_REVIEW, NUMBER_POOL_PROVISIONED, NUMBER_POOL_DEPROVISIONED, TCR_EVENT, VERIFIED
`description`	string	Description of the event.
`status`	enum: ACCEPTED, REJECTED, DORMANT, success, failed	The status of the campaign.

If you need webhook fields that are not listed inline here, read the webhook payload reference before writing the handler.

字段	类型	描述
`brandId`	string	与活动关联的品牌ID。
`campaignId`	string	活动ID。
`createDate`	string	活动创建的Unix时间戳。
`cspId`	string	与该活动关联的CSP的字母数字标识符。
`isTMobileRegistered`	boolean	指示该活动是否已在T-Mobile注册。
`type`	enum: TELNYX_EVENT, REGISTRATION, MNO_REVIEW, TELNYX_REVIEW, NUMBER_POOL_PROVISIONED, NUMBER_POOL_DEPROVISIONED, TCR_EVENT, VERIFIED
`description`	string	事件描述。
`status`	enum: ACCEPTED, REJECTED, DORMANT, success, failed	活动状态。

如果你需要此处未列出的webhook字段，请在编写处理程序前阅读webhook payload参考。

Important Supporting Operations

重要支持操作

Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.

当上述核心任务与你的流程接近，但你需要常见的变体或后续步骤时，请使用这些接口。

Get Brand

查询品牌信息

Inspect the current state of an existing brand registration.

GET /10dlc/brand/{brandId}

Parameter	Type	Required	Description
`brandId`	string (UUID)	Yes

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand/BXXX001"

Primary response fields:

```
.data.status
```
```
.data.state
```
```
.data.altBusinessId
```
```
.data.altBusinessIdType
```
```
.data.assignedCampaignsCount
```
```
.data.brandId
```

查看现有品牌注册的当前状态。

GET /10dlc/brand/{brandId}

参数	类型	必填	描述
`brandId`	string (UUID)	是

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand/BXXX001"

主要响应字段：

```
.data.status
```
```
.data.state
```
```
.data.altBusinessId
```
```
.data.altBusinessIdType
```
```
.data.assignedCampaignsCount
```
```
.data.brandId
```

Qualify By Usecase

按用例校验

Fetch the current state before updating, deleting, or making control-flow decisions.

GET /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}

Parameter	Type	Required	Description
`usecase`	string	Yes
`brandId`	string (UUID)	Yes

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/BXXX001/usecase/{usecase}"

Primary response fields:

```
.data.annualFee
```
```
.data.maxSubUsecases
```
```
.data.minSubUsecases
```
```
.data.mnoMetadata
```
```
.data.monthlyFee
```
```
.data.quarterlyFee
```

在进行更新、删除或做出控制流程决策前获取当前状态。

GET /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}

参数	类型	必填	描述
`usecase`	string	是
`brandId`	string (UUID)	是

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/BXXX001/usecase/{usecase}"

主要响应字段：

```
.data.annualFee
```
```
.data.maxSubUsecases
```
```
.data.minSubUsecases
```
```
.data.mnoMetadata
```
```
.data.monthlyFee
```
```
.data.quarterlyFee
```

Create New Phone Number Campaign

创建新的电话号码活动

Create or provision an additional resource when the core tasks do not cover this flow.

POST /10dlc/phone_number_campaigns

Parameter	Type	Required	Description
`phoneNumber`	string (E.164)	Yes	The phone number you want to link to a specified campaign.
`campaignId`	string (UUID)	Yes	The ID of the campaign you want to link to the specified pho...

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumber": "+18005550199",
  "campaignId": "4b300178-131c-d902-d54e-72d90ba1620j"
}' \
  "https://api.telnyx.com/v2/10dlc/phone_number_campaigns"

Primary response fields:

```
.data.assignmentStatus
```
```
.data.brandId
```
```
.data.campaignId
```
```
.data.createdAt
```
```
.data.failureReasons
```
```
.data.phoneNumber
```

当核心任务未覆盖该流程时，创建或开通额外资源。

POST /10dlc/phone_number_campaigns

参数	类型	必填	描述
`phoneNumber`	string (E.164)	是	你想要关联到指定活动的电话号码。
`campaignId`	string (UUID)	是	你想要关联到指定电话号码的活动ID。

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumber": "+18005550199",
  "campaignId": "4b300178-131c-d902-d54e-72d90ba1620j"
}' \
  "https://api.telnyx.com/v2/10dlc/phone_number_campaigns"

主要响应字段：

```
.data.assignmentStatus
```
```
.data.brandId
```
```
.data.campaignId
```
```
.data.createdAt
```
```
.data.failureReasons
```
```
.data.phoneNumber
```

Get campaign

查询活动信息

Inspect the current state of an existing campaign registration.

GET /10dlc/campaign/{campaignId}

Parameter	Type	Required	Description
`campaignId`	string (UUID)	Yes

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/campaign/CXXX001"

Primary response fields:

```
.data.status
```
```
.data.ageGated
```
```
.data.autoRenewal
```
```
.data.billedDate
```
```
.data.brandDisplayName
```
```
.data.brandId
```

查看现有活动注册的当前状态。

GET /10dlc/campaign/{campaignId}

参数	类型	必填	描述
`campaignId`	string (UUID)	是

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/campaign/CXXX001"

主要响应字段：

```
.data.status
```
```
.data.ageGated
```
```
.data.autoRenewal
```
```
.data.billedDate
```
```
.data.brandDisplayName
```
```
.data.brandId
```

List Brands

列出品牌

Inspect available resources or choose an existing resource before mutating it.

GET /10dlc/brand

Parameter	Type	Required	Description
`sort`	enum (assignedCampaignsCount, -assignedCampaignsCount, brandId, -brandId, createdAt, ...)	No	Specifies the sort order for results.
`page`	integer	No
`recordsPerPage`	integer	No	number of records per page.
...			+6 optional params in references/api-details.md

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand?sort=-identityStatus&brandId=826ef77a-348c-445b-81a5-a9b13c68fbfe&tcrBrandId=BBAND1"

Primary response fields:

```
.data.page
```
```
.data.records
```
```
.data.totalRecords
```

在修改资源前查看可用资源或选择现有资源。

GET /10dlc/brand

参数	类型	必填	描述
`sort`	enum (assignedCampaignsCount, -assignedCampaignsCount, brandId, -brandId, createdAt, ...)	否	指定结果的排序顺序。
`page`	integer	否
`recordsPerPage`	integer	否	每页的记录数量。
...			另有6个可选参数，详见references/api-details.md

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand?sort=-identityStatus&brandId=826ef77a-348c-445b-81a5-a9b13c68fbfe&tcrBrandId=BBAND1"

主要响应字段：

```
.data.page
```
```
.data.records
```
```
.data.totalRecords
```

Get Brand Feedback By Id

根据ID获取品牌反馈

Fetch the current state before updating, deleting, or making control-flow decisions.

GET /10dlc/brand/feedback/{brandId}

Parameter	Type	Required	Description
`brandId`	string (UUID)	Yes

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand/feedback/BXXX001"

Primary response fields:

```
.data.brandId
```
```
.data.category
```

在进行更新、删除或做出控制流程决策前获取当前状态。

GET /10dlc/brand/feedback/{brandId}

参数	类型	必填	描述
`brandId`	string (UUID)	是

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/10dlc/brand/feedback/BXXX001"

主要响应字段：

```
.data.brandId
```
```
.data.category
```

Additional Operations

额外操作

Use the core tasks above first. The operations below are indexed here with exact SDK methods and required params; use references/api-details.md for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read the optional-parameters section and the response-schemas section so you do not guess missing fields.

Operation	SDK method	Endpoint	Use when	Required params
Get Brand SMS OTP Status	HTTP only	`GET /10dlc/brand/smsOtp/{referenceId}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`referenceId`
Update Brand	HTTP only	`PUT /10dlc/brand/{brandId}`	Inspect the current state of an existing brand registration.	`entityType` , `displayName` , `country` , `email` , +2 more
Delete Brand	HTTP only	`DELETE /10dlc/brand/{brandId}`	Inspect the current state of an existing brand registration.	`brandId`
Resend brand 2FA email	HTTP only	`POST /10dlc/brand/{brandId}/2faEmail`	Create or provision an additional resource when the core tasks do not cover this flow.	`brandId`
List External Vettings	HTTP only	`GET /10dlc/brand/{brandId}/externalVetting`	Fetch the current state before updating, deleting, or making control-flow decisions.	`brandId`
Order Brand External Vetting	HTTP only	`POST /10dlc/brand/{brandId}/externalVetting`	Create or provision an additional resource when the core tasks do not cover this flow.	`evpId` , `vettingClass` , `brandId`
Import External Vetting Record	HTTP only	`PUT /10dlc/brand/{brandId}/externalVetting`	Modify an existing resource without recreating it.	`evpId` , `vettingId` , `brandId`
Revet Brand	HTTP only	`PUT /10dlc/brand/{brandId}/revet`	Modify an existing resource without recreating it.	`brandId`
Get Brand SMS OTP Status by Brand ID	HTTP only	`GET /10dlc/brand/{brandId}/smsOtp`	Fetch the current state before updating, deleting, or making control-flow decisions.	`brandId`
Trigger Brand SMS OTP	HTTP only	`POST /10dlc/brand/{brandId}/smsOtp`	Create or provision an additional resource when the core tasks do not cover this flow.	`pinSms` , `successSms` , `brandId`
Verify Brand SMS OTP	HTTP only	`PUT /10dlc/brand/{brandId}/smsOtp`	Modify an existing resource without recreating it.	`otpPin` , `brandId`
List Campaigns	HTTP only	`GET /10dlc/campaign`	Inspect available resources or choose an existing resource before mutating it.	None
Accept Shared Campaign	HTTP only	`POST /10dlc/campaign/acceptSharing/{campaignId}`	Create or provision an additional resource when the core tasks do not cover this flow.	`campaignId`
Get Campaign Cost	HTTP only	`GET /10dlc/campaign/usecase/cost`	Inspect available resources or choose an existing resource before mutating it.	None
Update campaign	HTTP only	`PUT /10dlc/campaign/{campaignId}`	Inspect the current state of an existing campaign registration.	`campaignId`
Deactivate campaign	HTTP only	`DELETE /10dlc/campaign/{campaignId}`	Inspect the current state of an existing campaign registration.	`campaignId`
Submit campaign appeal for manual review	HTTP only	`POST /10dlc/campaign/{campaignId}/appeal`	Create or provision an additional resource when the core tasks do not cover this flow.	`appeal_reason` , `campaignId`
Get Campaign Mno Metadata	HTTP only	`GET /10dlc/campaign/{campaignId}/mnoMetadata`	Fetch the current state before updating, deleting, or making control-flow decisions.	`campaignId`
Get campaign operation status	HTTP only	`GET /10dlc/campaign/{campaignId}/operationStatus`	Fetch the current state before updating, deleting, or making control-flow decisions.	`campaignId`
Get OSR campaign attributes	HTTP only	`GET /10dlc/campaign/{campaignId}/osr/attributes`	Fetch the current state before updating, deleting, or making control-flow decisions.	`campaignId`
Get Sharing Status	HTTP only	`GET /10dlc/campaign/{campaignId}/sharing`	Fetch the current state before updating, deleting, or making control-flow decisions.	`campaignId`
List shared partner campaigns	HTTP only	`GET /10dlc/partnerCampaign/sharedByMe`	Inspect available resources or choose an existing resource before mutating it.	None
Get Sharing Status	HTTP only	`GET /10dlc/partnerCampaign/{campaignId}/sharing`	Fetch the current state before updating, deleting, or making control-flow decisions.	`campaignId`
List Shared Campaigns	HTTP only	`GET /10dlc/partner_campaigns`	Inspect available resources or choose an existing resource before mutating it.	None
Get Single Shared Campaign	HTTP only	`GET /10dlc/partner_campaigns/{campaignId}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`campaignId`
Update Single Shared Campaign	HTTP only	`PATCH /10dlc/partner_campaigns/{campaignId}`	Modify an existing resource without recreating it.	`campaignId`
Get Assignment Task Status	HTTP only	`GET /10dlc/phoneNumberAssignmentByProfile/{taskId}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`taskId`
Get Phone Number Status	HTTP only	`GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers`	Fetch the current state before updating, deleting, or making control-flow decisions.	`taskId`
List phone number campaigns	HTTP only	`GET /10dlc/phone_number_campaigns`	Inspect available resources or choose an existing resource before mutating it.	None
Get Single Phone Number Campaign	HTTP only	`GET /10dlc/phone_number_campaigns/{phoneNumber}`	Fetch the current state before updating, deleting, or making control-flow decisions.	`phoneNumber`
Create New Phone Number Campaign	HTTP only	`PUT /10dlc/phone_number_campaigns/{phoneNumber}`	Modify an existing resource without recreating it.	`phoneNumber` , `campaignId` , `phoneNumber`
Delete Phone Number Campaign	HTTP only	`DELETE /10dlc/phone_number_campaigns/{phoneNumber}`	Remove, detach, or clean up an existing resource.	`phoneNumber`

For exhaustive optional parameters, full response schemas, and complete webhook payloads, see references/api-details.md.

请优先使用上述核心任务。下方列出的操作提供了准确的SDK方法和必填参数；请参考references/api-details.md查看完整的可选参数、响应模式和低频率webhook payload。在使用下方任意操作前，请阅读可选参数章节和响应模式章节，不要臆测缺失的字段。

操作	SDK方法	接口路径	使用场景	必填参数
获取品牌SMS OTP状态	仅支持HTTP	`GET /10dlc/brand/smsOtp/{referenceId}`	在进行更新、删除或做出控制流程决策前获取当前状态。	`referenceId`
更新品牌	仅支持HTTP	`PUT /10dlc/brand/{brandId}`	查看现有品牌注册的当前状态。	`entityType` , `displayName` , `country` , `email` , 以及2个额外参数
删除品牌	仅支持HTTP	`DELETE /10dlc/brand/{brandId}`	查看现有品牌注册的当前状态。	`brandId`
重发品牌2FA邮件	仅支持HTTP	`POST /10dlc/brand/{brandId}/2faEmail`	当核心任务未覆盖该流程时，创建或开通额外资源。	`brandId`
列出外部审核记录	仅支持HTTP	`GET /10dlc/brand/{brandId}/externalVetting`	在进行更新、删除或做出控制流程决策前获取当前状态。	`brandId`
申请品牌外部审核	仅支持HTTP	`POST /10dlc/brand/{brandId}/externalVetting`	当核心任务未覆盖该流程时，创建或开通额外资源。	`evpId` , `vettingClass` , `brandId`
导入外部审核记录	仅支持HTTP	`PUT /10dlc/brand/{brandId}/externalVetting`	修改现有资源而无需重新创建。	`evpId` , `vettingId` , `brandId`
重新审核品牌	仅支持HTTP	`PUT /10dlc/brand/{brandId}/revet`	修改现有资源而无需重新创建。	`brandId`
根据品牌ID获取品牌SMS OTP状态	仅支持HTTP	`GET /10dlc/brand/{brandId}/smsOtp`	在进行更新、删除或做出控制流程决策前获取当前状态。	`brandId`
触发品牌SMS OTP	仅支持HTTP	`POST /10dlc/brand/{brandId}/smsOtp`	当核心任务未覆盖该流程时，创建或开通额外资源。	`pinSms` , `successSms` , `brandId`
验证品牌SMS OTP	仅支持HTTP	`PUT /10dlc/brand/{brandId}/smsOtp`	修改现有资源而无需重新创建。	`otpPin` , `brandId`
列出活动	仅支持HTTP	`GET /10dlc/campaign`	在修改资源前查看可用资源或选择现有资源。	无
接受共享活动	仅支持HTTP	`POST /10dlc/campaign/acceptSharing/{campaignId}`	当核心任务未覆盖该流程时，创建或开通额外资源。	`campaignId`
获取活动成本	仅支持HTTP	`GET /10dlc/campaign/usecase/cost`	在修改资源前查看可用资源或选择现有资源。	无
更新活动	仅支持HTTP	`PUT /10dlc/campaign/{campaignId}`	查看现有活动注册的当前状态。	`campaignId`
停用活动	仅支持HTTP	`DELETE /10dlc/campaign/{campaignId}`	查看现有活动注册的当前状态。	`campaignId`
提交活动申诉供人工审核	仅支持HTTP	`POST /10dlc/campaign/{campaignId}/appeal`	当核心任务未覆盖该流程时，创建或开通额外资源。	`appeal_reason` , `campaignId`
获取活动MNO元数据	仅支持HTTP	`GET /10dlc/campaign/{campaignId}/mnoMetadata`	在进行更新、删除或做出控制流程决策前获取当前状态。	`campaignId`
获取活动操作状态	仅支持HTTP	`GET /10dlc/campaign/{campaignId}/operationStatus`	在进行更新、删除或做出控制流程决策前获取当前状态。	`campaignId`
获取OSR活动属性	仅支持HTTP	`GET /10dlc/campaign/{campaignId}/osr/attributes`	在进行更新、删除或做出控制流程决策前获取当前状态。	`campaignId`
获取共享状态	仅支持HTTP	`GET /10dlc/campaign/{campaignId}/sharing`	在进行更新、删除或做出控制流程决策前获取当前状态。	`campaignId`
列出我共享的合作伙伴活动	仅支持HTTP	`GET /10dlc/partnerCampaign/sharedByMe`	在修改资源前查看可用资源或选择现有资源。	无
获取共享状态	仅支持HTTP	`GET /10dlc/partnerCampaign/{campaignId}/sharing`	在进行更新、删除或做出控制流程决策前获取当前状态。	`campaignId`
列出共享活动	仅支持HTTP	`GET /10dlc/partner_campaigns`	在修改资源前查看可用资源或选择现有资源。	无
获取单个共享活动	仅支持HTTP	`GET /10dlc/partner_campaigns/{campaignId}`	在进行更新、删除或做出控制流程决策前获取当前状态。	`campaignId`
更新单个共享活动	仅支持HTTP	`PATCH /10dlc/partner_campaigns/{campaignId}`	修改现有资源而无需重新创建。	`campaignId`
获取分配任务状态	仅支持HTTP	`GET /10dlc/phoneNumberAssignmentByProfile/{taskId}`	在进行更新、删除或做出控制流程决策前获取当前状态。	`taskId`
获取电话号码状态	仅支持HTTP	`GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers`	在进行更新、删除或做出控制流程决策前获取当前状态。	`taskId`
列出电话号码活动	仅支持HTTP	`GET /10dlc/phone_number_campaigns`	在修改资源前查看可用资源或选择现有资源。	无
获取单个电话号码活动	仅支持HTTP	`GET /10dlc/phone_number_campaigns/{phoneNumber}`	在进行更新、删除或做出控制流程决策前获取当前状态。	`phoneNumber`
创建新的电话号码活动	仅支持HTTP	`PUT /10dlc/phone_number_campaigns/{phoneNumber}`	修改现有资源而无需重新创建。	`phoneNumber` , `campaignId` , `phoneNumber`
删除电话号码活动	仅支持HTTP	`DELETE /10dlc/phone_number_campaigns/{phoneNumber}`	移除、解绑或清理现有资源。	`phoneNumber`

如需完整的可选参数、完整响应模式和全部webhook payload，请查看references/api-details.md。