Submit an RCS agent for launch
Adds the campaign and testing configuration, then starts asynchronous carrier launch. Agent basics must already be submitted. Repeating a launch that is already in progress returns the current agent without creating new work.
POST
/
rcs
/
agents
/
{id}
/
launch
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.rcs.agents.launch('id', {
campaign: 'campaign',
testing: 'testing',
});
console.log(response.agent_id);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.rcs.agents.launch(
id="id",
campaign="campaign",
testing="testing",
)
print(response.agent_id)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Rcs.Agents.Launch(
context.TODO(),
"id",
telnyx.RcAgentLaunchParams{
Campaign: "campaign",
Testing: "testing",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.rcs.agents.AgentLaunchParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
AgentLaunchParams params = AgentLaunchParams.builder()
.campaign("campaign")
.testing("testing")
.build();
var response = client.rcs().agents().launch("id", params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.rcs.agents.launch("id", campaign: "campaign", testing: "testing")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->rcs->agents->launch(
'id',
campaign: 'campaign',
testing: 'testing',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx rcs:agents launch \
--api-key 'My API Key' \
--id id \
--campaign campaign \
--testing testingcurl --request POST \
--url https://api.telnyx.com/v2/rcs/agents/{id}/launch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign": {
"company_overview": "Acme provides online retail services.",
"agent_overview": "The agent sends order confirmations and delivery updates.",
"interactions": [
{
"interaction_type": "TRANSACTIONAL_UPDATES"
}
],
"message_examples": [
"Your Acme order is confirmed.",
"Your Acme order has shipped.",
"Your Acme order was delivered."
],
"consent_settings": {
"opt_in_methods": [
{
"method_type": "WEBSITE"
}
],
"call_to_action": "Select RCS updates during checkout.",
"call_to_action_url": "https://www.example.com/checkout",
"call_to_action_media_url": "https://www.example.com/rcs/opt-in.png",
"double_opt_in": false,
"opt_in_message": "You are subscribed to Acme order updates.",
"help_response": "Contact support@example.com for help.",
"opt_out_response": "You will receive no more messages."
}
},
"testing": {
"test_url": "https://www.example.com/rcs/test-video",
"additional_information": "Demonstrates START, STOP, HELP, and an order-status interaction."
}
}
'{
"agent_id": "22222222-2222-4222-8222-222222222222",
"brand_id": "11111111-1111-4111-8111-111111111111",
"display_name": "Acme Order Updates",
"use_case": "TRANSACTIONAL",
"status": "SUBMITTED",
"profile_id": "40000000-0000-0000-0000-000000000001",
"basics_status": "SUBMITTED",
"campaign_status": null,
"testing_status": null,
"billing_category": "NON_CONVERSATIONAL",
"hosting_region": null,
"configuration": {
"basics": {
"description": "Order confirmations and delivery updates",
"logo_url": "https://www.example.com/rcs/logo.png",
"hero_url": "https://www.example.com/rcs/hero.png",
"brand_color": "#123456",
"privacy_policy_url": "https://www.example.com/privacy",
"terms_and_conditions_url": "https://www.example.com/terms",
"email": {
"address": "support@example.com",
"label": "Support"
}
},
"campaign": null,
"testing": null
},
"carrier_approvals": [],
"test_devices": [],
"capabilities": {
"brand_entity": true,
"brand_verification": true,
"submission_sections": true,
"distinct_launch_phase": false,
"per_carrier_approval": false,
"templates": false,
"campaigns": false,
"vendor_webhooks": false,
"invite_test_devices": false
}
}{
"detail": "The requested RCS resource was not found."
}{
"detail": "The requested RCS resource was not found."
}{
"detail": "The requested RCS resource was not found."
}{
"detail": [
{
"loc": [
"body",
"display_name"
],
"msg": "Field required",
"type": "missing"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The Telnyx-assigned agent identifier.
Body
application/json
Response
The launch submission was accepted.
Available options:
MULTI_USE, PROMOTIONAL, TRANSACTIONAL, OTP Available options:
CREATED, SUBMITTED, VERIFYING, VERIFIED, LAUNCHING, LAUNCHED, LIVE, REJECTED, FAILED Available options:
SUBMITTED, APPROVED, REJECTED Available options:
SUBMITTED, APPROVED, REJECTED Available options:
SUBMITTED, APPROVED, REJECTED Available options:
NON_CONVERSATIONAL, CONVERSATIONAL Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const response = await client.rcs.agents.launch('id', {
campaign: 'campaign',
testing: 'testing',
});
console.log(response.agent_id);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.rcs.agents.launch(
id="id",
campaign="campaign",
testing="testing",
)
print(response.agent_id)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
response, err := client.Rcs.Agents.Launch(
context.TODO(),
"id",
telnyx.RcAgentLaunchParams{
Campaign: "campaign",
Testing: "testing",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.rcs.agents.AgentLaunchParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
AgentLaunchParams params = AgentLaunchParams.builder()
.campaign("campaign")
.testing("testing")
.build();
var response = client.rcs().agents().launch("id", params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
response = telnyx.rcs.agents.launch("id", campaign: "campaign", testing: "testing")
puts(response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$response = $client->rcs->agents->launch(
'id',
campaign: 'campaign',
testing: 'testing',
);
var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx rcs:agents launch \
--api-key 'My API Key' \
--id id \
--campaign campaign \
--testing testingcurl --request POST \
--url https://api.telnyx.com/v2/rcs/agents/{id}/launch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign": {
"company_overview": "Acme provides online retail services.",
"agent_overview": "The agent sends order confirmations and delivery updates.",
"interactions": [
{
"interaction_type": "TRANSACTIONAL_UPDATES"
}
],
"message_examples": [
"Your Acme order is confirmed.",
"Your Acme order has shipped.",
"Your Acme order was delivered."
],
"consent_settings": {
"opt_in_methods": [
{
"method_type": "WEBSITE"
}
],
"call_to_action": "Select RCS updates during checkout.",
"call_to_action_url": "https://www.example.com/checkout",
"call_to_action_media_url": "https://www.example.com/rcs/opt-in.png",
"double_opt_in": false,
"opt_in_message": "You are subscribed to Acme order updates.",
"help_response": "Contact support@example.com for help.",
"opt_out_response": "You will receive no more messages."
}
},
"testing": {
"test_url": "https://www.example.com/rcs/test-video",
"additional_information": "Demonstrates START, STOP, HELP, and an order-status interaction."
}
}
'{
"agent_id": "22222222-2222-4222-8222-222222222222",
"brand_id": "11111111-1111-4111-8111-111111111111",
"display_name": "Acme Order Updates",
"use_case": "TRANSACTIONAL",
"status": "SUBMITTED",
"profile_id": "40000000-0000-0000-0000-000000000001",
"basics_status": "SUBMITTED",
"campaign_status": null,
"testing_status": null,
"billing_category": "NON_CONVERSATIONAL",
"hosting_region": null,
"configuration": {
"basics": {
"description": "Order confirmations and delivery updates",
"logo_url": "https://www.example.com/rcs/logo.png",
"hero_url": "https://www.example.com/rcs/hero.png",
"brand_color": "#123456",
"privacy_policy_url": "https://www.example.com/privacy",
"terms_and_conditions_url": "https://www.example.com/terms",
"email": {
"address": "support@example.com",
"label": "Support"
}
},
"campaign": null,
"testing": null
},
"carrier_approvals": [],
"test_devices": [],
"capabilities": {
"brand_entity": true,
"brand_verification": true,
"submission_sections": true,
"distinct_launch_phase": false,
"per_carrier_approval": false,
"templates": false,
"campaigns": false,
"vendor_webhooks": false,
"invite_test_devices": false
}
}{
"detail": "The requested RCS resource was not found."
}{
"detail": "The requested RCS resource was not found."
}{
"detail": "The requested RCS resource was not found."
}{
"detail": [
{
"loc": [
"body",
"display_name"
],
"msg": "Field required",
"type": "missing"
}
]
}