API Reference | Pico Cloud Technology Ltd

Authentication

PICO API uses API keys and JWT token to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via the following HTTP headers. Only the API for retrieving JWT token does not require the Authorization field. You do not need to provide a password.

Required HTTP Headers

"X-API-Key": "1O1IQxPv53888888899999000538888888999999"
"Authorization": "Bearer eyJhbGciOiJIUzUxMiJ9..."

The JWT token expires if the time interval between each request exceeds 30 minutes. If the token is incorrect or expired, you will receive a 401 error:

401 Unauthorized Example

"msg": "請求訪問：/xxx/yyy，驗證失敗，無法訪問系统資源"
"code": "401"

All API requests must be made over HTTPS. Calls over plain HTTP will fail. Requests without authentication will also fail. Please contact our sales team to get the assigned API keys for your account.

Security Warning

Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, or front-end applications.

IP Whitelist

If you need to enable the IP whitelist feature, use the domain api.picotw.com instead of rest.picotw.com. Submit your IP address on the "HTTP IP Whitelist" page in the Pico platform and contact the sales team for backend approval.

Security Schemes

Type	Name	In
apiKey	`Authorization`	HEADER
apiKey	`X-API-Key`	HEADER

Errors

Pico Cloud uses conventional HTTP response codes to indicate success or failure. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error based on the information provided.

HTTP Code	Status	Description
`200`	`OK`	The request was successful.
`400`	`BAD_REQUEST`	The request was unacceptable, often due to a missing or invalid parameter.
`401`	`UNAUTHORIZED`	JWT token is missing, invalid, or expired. Retrieve a new token and retry.
`417`	`EXPECTATION_FAILED`	The server could not meet the expectation given in the request.

Error Response Body

All error responses return a JSON body with the following structure:

Error Response Schema

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca",
  "errors": ["Error description message"]
}

GET

Retrieve JWT Token

Before performing operations, you must retrieve a JWT token. This token is required in the Authorization header for all subsequent requests.

Path Parameters

username string

Your unique API account username.

Exampleuser333

Header Parameters

X-API-Key string

Your account API Key.

Example3RbGvrZp...

Response Fields

request_id string The ID of this request operation.
token string The JWT token for authentication. Use this in the `Authorization: Bearer <token>` header for all subsequent API requests.

Responses

HTTP Code	Description	Schema
`200`	OK	UserTokenResponse
`400`	BAD_REQUEST	MsgExceptionResponse

Produces

application/json

Security

Type	Name	Scopes
apiKey	api_key	global

cURL

curl -X GET "https://rest.picotw.com/token/user333" \
  -H "X-API-Key: 3RbGvrZp53888888899999000"

Response 200 OK

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca",
  "token": "eyJhbGciOiJIUzUxMiJ9..."
}

Rate Limit: 1 request per second per API key.

POST

Create Campaign

Create a campaign in your account. Campaigns are used to organise and group your message templates.

POST https://rest.picotw.com/campaign

Body Parameters

username string API account name.	Exampleuser333
name string The name of the campaign. Length: 1 – 50 characters.	ExampleMy Campaign
remark string A description or note for the campaign. Length: 0 – 255 characters.

Responses

HTTP Code	Description	Schema
`200`	OK	AddCampaignResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Consumes

application/json

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X POST "https://rest.picotw.com/campaign" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "username": "user333",
    "name": "Campaign",
    "remark": "Campaign"
  }'

Response 200 OK

{
  "request_id": "db675a0f-c0ca-46b1-bfc1-abf76663feee"
}

GET

List Campaigns

Retrieve a list of all campaigns associated with your account.

GET https://rest.picotw.com/campaign

Response Fields

campaigns array Array of campaign objects. Each contains `campaignId`, `name`, `remark`, `username`, and `createdDatetime`.
request_id string The ID of this request operation.
total integer Total number of campaigns in your account.	Example1

Responses

HTTP Code	Description	Schema
`200`	OK	FindCampaignResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X GET "https://rest.picotw.com/campaign" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

Response 200 OK

{
  "campaigns": [
    {
      "campaignId": "db675a0f-c0ca-46b1-bfc1-abf76663feee",
      "name": "Campaign",
      "remark": "Campaign",
      "username": "user333",
      "createdDatetime": "2024-01-01T00:00:00.000Z"
    }
  ],
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca",
  "total": 1
}

PUT

Update Campaign

Update the name or remark of an existing campaign in your account.

PUT https://rest.picotw.com/campaign

Body Parameters

campaignId string The ID of the campaign to update.	Exampledb675a0f-...
username string API account name.	Exampleuser333
name string The new name for the campaign. Length: 1 – 50 characters.	ExampleNew Campaign
remark string An updated note for the campaign. Length: 0 – 255 characters.

Responses

HTTP Code	Description	Schema
`200`	OK	UpdateCampaignResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Consumes

application/json

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X PUT "https://rest.picotw.com/campaign" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "campaignId": "db675a0f-c0ca-46b1-bfc1-abf76663feee",
    "username": "user333",
    "name": "New Campaign",
    "remark": "New Campaign"
  }'

Response 200 OK

{
  "campaign_id": "db675a0f-c0ca-46b1-bfc1-abf76663feee",
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca"
}

DELETE

Delete Campaign

Permanently delete a campaign from your account.

DELETE https://rest.picotw.com/campaign

Body Parameters

campaignId string

The ID of the campaign to delete.

Exampledb675a0f-...

Responses

HTTP Code	Description	Schema
`200`	OK	DeleteCampaignResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X DELETE "https://rest.picotw.com/campaign" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "campaignId": "db675a0f-c0ca-46b1-bfc1-abf76663feee"
  }'

Response 200 OK

{
  "campaign_id": "db675a0f-c0ca-46b1-bfc1-abf76663feee",
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca"
}

POST

Create SMS Template

Create a new SMS template to use for future campaigns.

POST https://rest.picotw.com/template/sms

Body Parameters

username string API account name.	Exampleuser333
campaignId string The ID of the campaign to associate this template with.	Exampledb675a0f-...
text string The content of the SMS template. Length: 1 – 4000 characters.	ExampleHello World

Responses

HTTP Code	Description	Schema
`200`	OK	AddMessageTemplateResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Consumes

application/json

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X POST "https://rest.picotw.com/template/sms" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "username": "user333",
    "campaignId": "db675a0f-c0ca-46b1-bfc1-abf76663feee",
    "text": "【OKX】Due to regional restriction, please upgrade and switch to the international version abcd.xyz abcd.xyz"
  }'

Response 200 OK

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca"
}

POST

Create MMS Template

Create a new MMS template with text, an optional subject, and an optional image URL.

POST https://rest.picotw.com/template/mms

Body Parameters

username string API account name.	Exampleuser333
campaignId string The ID of the campaign to associate this template with.	Exampledb675a0f-...
text string The text content of the MMS template. Length: 1 – 4000 characters.	ExampleHello World
subject string The subject line of the MMS. Length: 1 – 15 characters.	ExampleNotice
image_url string The URL of the media image to attach to this MMS template.	Examplehttps://...

Responses

HTTP Code	Description	Schema
`200`	OK	AddMessageTemplateResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Consumes

application/json

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X POST "https://rest.picotw.com/template/mms" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "username": "user333",
    "campaignId": "db675a0f-c0ca-46b1-bfc1-abf76663feee",
    "subject": "Important Notice",
    "text": "Your message content here",
    "image_url": "https://iili.io/abc.jpg"
  }'

Response 200 OK

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca"
}

GET

List Message Templates

Retrieve all message templates in your account, filtered by type (SMS or MMS).

GET https://rest.picotw.com/template?type={SMS|MMS}

Query Parameters

type enum

The type of message template to list.

ExampleSMS

Response Fields

message_templates array Array of template objects. Each contains `templateId`, `campaignId`, `campaignName`, `text`, `status`, `username`, and `createdDatetime`.
request_id string The ID of this request operation.
total integer Total number of templates returned.	Example1

Responses

HTTP Code	Description	Schema
`200`	OK	FindMessageTemplateResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X GET "https://rest.picotw.com/template?type=SMS" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

Response 200 OK

{
  "message_templates": [
    {
      "templateId": "04183157-6249-4fbc-bac9-4d1bbf792e89",
      "campaignId": "db675a0f-c0ca-46b1-bfc1-abf76663feee",
      "campaignName": "Campaign",
      "text": "Your template text",
      "status": "active",
      "username": "user333",
      "createdDatetime": "2024-01-01T00:00:00.000Z"
    }
  ],
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca",
  "total": 1
}

DELETE

Delete Message Template

Permanently delete a message template from your account.

DELETE https://rest.picotw.com/template

Body Parameters

templateId string

The ID of the template to delete.

Example04183157-...

Responses

HTTP Code	Description	Schema
`200`	OK	DeleteMessageTemplateResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X DELETE "https://rest.picotw.com/template" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "templateId": "04183157-6249-4fbc-bac9-4d1bbf792e89"
  }'

Response 200 OK

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca",
  "templates_id": "04183157-6249-4fbc-bac9-4d1bbf792e89"
}

POST

Send an SMS

Send a single SMS message to a specific phone number. You can use either raw text or a pre-approved templateId.

POST https://rest.picotw.com/sms

Body Parameters

username string · required API account name.	Exampleuser333
from string · required The sender ID or number.	Example8612345678888
to string · required The destination number in E.164 format.	Example8612345678901
text string · conditional The message body. Length: 1 – 4000. Required if `templateId` is not provided.	ExampleYour code is 1234
templateId string · conditional UUID of a pre-approved SMS template. Length: 36. Required if `text` is not provided.	Examplexxxxxxxx-590b-...
callback string · optional Webhook URL to receive the Delivery Receipt (DLR). The endpoint must accept HTTP POST requests.	Examplehttps://...

Responses

HTTP Code	Description	Schema
`200`	OK	MsgInfo
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Consumes

application/json

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL — Using text

curl -X POST "https://rest.picotw.com/sms" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "username":"user333",
    "from":"8612345678888",
    "to":"8612345678901",
    "text":"Your verification code is 1234",
    "callback":"https://abcdefg.m.pipedream.net/"
  }'

cURL — Using templateId

curl -X POST "https://rest.picotw.com/sms" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "username":"user333",
    "from":"8612345678888",
    "to":"8612345678901",
    "templateId":"xxxxxxxx-590b-42c5-ab37-ab6894cf3ae8",
    "callback":"https://abcdefg.m.pipedream.net/"
  }'

Response 200 OK

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca"
}

Delivery Receipt (DLR)

When a callback URL is provided, Pico will POST the delivery receipt to that endpoint. If the endpoint does not return HTTP 200, Pico will retry up to 3 times with a 10-minute interval before discarding the receipt.

Sample DLR Payload

{
  "status": "delivered",
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca",
  "msisdn": "8615512345678",
  "message_timestamp": "2022-01-07T14:21:29.905Z",
  "err-code": "0"
}

DLR Statuses

delivered accepted expired undelivered failed rejected deleted unknown

Rate Limit: 30 requests per second per API key. Contact sales for higher throughput.

POST

Send an MMS

Send a single MMS message using a pre-created MMS template. Each API key is limited to 30 requests per second.

POST https://rest.picotw.com/mms

Body Parameters

username string API account name.	Exampleuser333
from string The sender number in E.164 format.	Example8612345678888
to string Destination number in E.164 format.	Example8612345678901
templateId string UUID of the MMS template to use for delivery. Length: 36.	Examplexxxxxxxx-...
callback string Webhook URL to receive the delivery receipt (DLR). Must accept HTTP POST.

Responses

HTTP Code	Description	Schema
`200`	OK	MsgInfo
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Consumes

application/json

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X POST "https://rest.picotw.com/mms" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "username": "user333",
    "from": "8612345678888",
    "to": "8612345678901",
    "templateId": "xxxxxxxx-590b-42c5-ab37-ab6894cf3ae8",
    "callback": "https://callback.url/"
  }'

Response 200 OK

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca"
}

Rate Limit: 30 requests per second per API key. Contact sales for higher throughput.

POST

Send Voice TTS

Convert text to speech and deliver it as a voice call. PICO's TTS API helps you send automated voice messages to any phone number.

POST https://rest.picotw.com/voice/tts

Body Parameters

username string API account name.	Exampleuser333
from string The caller number in E.164 format (e.g., 8612345678888).	Example8612345678888
to string Destination number in E.164 format (e.g., 8612345678901).	Example8612345678901
text string The text to be converted to speech. Length: 1 – 4000 characters.	ExampleYour code is 9999

Responses

HTTP Code	Description	Schema
`200`	OK	MsgInfo
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Consumes

application/json

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X POST "https://rest.picotw.com/voice/tts" \
  -H "X-API-Key: 1O1IQxPv53888888899999000538888888" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "username":"user333",
    "from":"8612345678888",
    "to":"8612345678901",
    "text":"Your verification code is 9999"
  }'

Response 200 OK

{
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca"
}

Rate Limit: 30 requests per second per API key. Contact sales for higher throughput.

GET

Get Account Balance

Retrieve the remaining credit balance in your account. Each API key is limited to 1 request per second.

GET https://rest.picotw.com/balance/{username}

Path Parameters

username string

Your API account username.

Exampleuser333

Response Fields

balance string The remaining balance in the account.	Example1234.56
request_id string The ID of this request operation.
username string The API account name associated with this balance.	Exampleuser333

Responses

HTTP Code	Description	Schema
`200`	OK	UserBalanceResponse
`400`	BAD_REQUEST	MsgExceptionResponse
`417`	EXPECTATION_FAILED	MsgExceptionResponse

Produces

application/json

Security

Type	Name	Scopes
apiKey	authorization	global
apiKey	api_key	global

cURL

curl -X GET "https://rest.picotw.com/balance/user333" \
  -H "X-API-Key: 3RbGvrZp53888888899999000" \
  -H "Authorization: Bearer eyJhbGciOiJIUzUxMiJ9..."

Response 200 OK

{
  "balance": "1234.56",
  "request_id": "9ca38439-732f-4c88-87c7-0b3eda19dfca",
  "username": "user333"
}

Rate Limit: 1 request per second per API key.

Definitions

Data schemas referenced by the API responses above.

AddCampaignRequest

Name	Description	Schema
namerequired	The name of campaign Length: 1 – 50	string
remarkoptional	The remark of campaign Length: 0 – 255	string
usernamerequired	API account name	string

AddCampaignResponse

Name	Description	Schema
request_idrequired	The ID of the created campaign	string

AddMessageTemplateResponse

Name	Description	Schema
request_idrequired	The ID of the created template	string

AddMmsTemplateRequest

Name	Description	Schema
usernamerequired	API account name	string
campaignIdrequired	The ID of campaign	string
textrequired	The text of MMS template Length: 1 – 4000	string
subjectoptional	The subject of MMS template Length: 1 – 15	string
image_urloptional	The media URL of MMS template	string

AddSmsTemplateRequest

Name	Description	Schema
usernamerequired	API account name	string
campaignIdrequired	The ID of campaign	string
textrequired	The text of SMS template Length: 1 – 4000	string

Campaign

Name	Description	Schema
campaignIdrequired	The ID of campaign	string (uuid)
namerequired	The name of campaign	string
remarkrequired	The remark of campaign	string
usernamerequired	The owner of campaign	string
createdDatetimerequired	The created datetime of campaign	string

DeleteCampaignRequest

Name	Description	Schema
campaignIdrequired	The ID of the deleted campaign	string

DeleteCampaignResponse

Name	Description	Schema
campaign_idrequired	The ID of the deleted campaign	string
request_idrequired	The ID of this request operation	string

DeleteMessageTemplateRequest

Name	Description	Schema
templateIdrequired	The ID of the deleted template	string

DeleteMessageTemplateResponse

Name	Description	Schema
request_idrequired	The ID of this request operation	string
templates_idrequired	The ID of the deleted template	string

FindCampaignResponse

Name	Description	Schema
campaignsrequired	All campaigns in your account	< Campaign > array
request_idrequired	The ID of this request operation	string
totalrequired	The total quantity of campaigns in your account	integer (int64)

FindMessageTemplateResponse

Name	Description	Schema
message_templatesrequired	All templates in your account	< MessageTemplate > array
request_idrequired	The ID of this request operation	string
totalrequired	The total quantity of templates in your account	integer (int64)

MessageTemplate

Name	Description	Schema
templateIdrequired	The ID of template	string (uuid)
campaignIdrequired	The ID of campaign	string (uuid)
campaignNamerequired	The name of campaign	string
textrequired	The text of template	string
statusrequired	The status of template	string
usernamerequired	The owner of template	string
createdDatetimerequired	The created datetime of template	string
subjectoptional	The subject of MMS template	string
mediaUrloptional	The media URL of MMS template	string

MmsNormalRequest

Name	Description	Schema
usernamerequired	API account name	string
fromrequired	The deliverer number in E.164 format	string
torequired	The recipient number in E.164 format	string
templateIdrequired	The ID of template for MMS delivery. Length: 36	string

MsgExceptionResponse

Name	Description	Schema
request_idrequired	The ID of this request operation	string
errorsrequired	The description of the errors	< string > array

MsgInfo

Name	Description	Schema
request_idrequired	The ID of this request operation	string

SmsNormalRequest

Name	Description	Schema
usernamerequired	API account name	string
fromrequired	The deliverer number	string
torequired	The recipient number in E.164 format	string
textrequired	The message body. Cannot be used with `templateId`. Length: 1 – 4000	string
templateIdrequired	Template ID for SMS delivery. Cannot be used with `text`. Length: 36	string
callbackoptional	Webhook URL for delivery receipt (DLR). Must accept HTTP POST.	string

UpdateCampaignRequest

Name	Description	Schema
campaignIdrequired	The ID of the updated campaign	string
usernamerequired	API account name	string
namerequired	The name of campaign Length: 1 – 50	string
remarkoptional	The remark of campaign Length: 0 – 255	string

UpdateCampaignResponse

Name	Description	Schema
campaign_idrequired	The ID of the updated campaign	string
request_idrequired	The ID of this request operation	string

UserBalanceResponse

Name	Description	Schema
balancerequired	The remaining balance in the account	string
request_idrequired	The ID of this request operation	string
usernamerequired	API account name	string

UserTokenResponse

Name	Description	Schema
request_idrequired	The ID of this request operation	string
tokenrequired	The JWT token for authentication	string

VoiceTtsRequest

Name	Description	Schema
usernamerequired	API account name	string
fromrequired	The caller number in E.164 format	string
torequired	The recipient number in E.164 format	string
textrequired	The TTS text to be converted. Length: 1 – 4000	string

Pico Cloud REST API

Authentication

Security Schemes

Errors

Error Response Body

Retrieve JWT Token

Create Campaign

List Campaigns

Update Campaign

Delete Campaign

Create SMS Template

Create MMS Template

List Message Templates

Delete Message Template

Send an SMS

Delivery Receipt (DLR)

DLR Statuses

Send an MMS

Send Voice TTS

Get Account Balance

Definitions

AddCampaignRequest

AddCampaignResponse

AddMessageTemplateResponse

AddMmsTemplateRequest

AddSmsTemplateRequest

Campaign

DeleteCampaignRequest

DeleteCampaignResponse

DeleteMessageTemplateRequest

DeleteMessageTemplateResponse

FindCampaignResponse

FindMessageTemplateResponse

MessageTemplate

MmsNormalRequest

MsgExceptionResponse

MsgInfo

SmsNormalRequest

UpdateCampaignRequest

UpdateCampaignResponse

UserBalanceResponse

UserTokenResponse

VoiceTtsRequest