Skip to content

Get Campaign Details using the TCR Campaign ID

Request

Returns the specified campaign by its TCR Campaign ID.

Security
BasicAuth or OAuth2
Path
projectIdstringrequired

Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.

Query
campaignRegistrationIdQuerystringrequired

Campaign Registration Id returned by the create campaign API.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://us10dlc.numbers.api.sinch.com/v1/projects/{projectId}/campaignRegistrations:fetchByTcrCampaignId?campaignRegistrationIdQuery=string'

Responses

A successful response.

Bodyapplication/json
campaignIdstring, <= 7 characters

Campaign ID returned by external partner. i.e. TCR Campaign Id

campaignNamestring, <= 128 characters

Optional name to help track and view campaign.

campaignRegistrationIdstring, <= 26 characters

Campaign Registration Id returned by the Create Campaign API

createDatestring, (date-time)

Campaign Creation Date

modifiedDatestring, (date-time)

Campaign Modified Date

createdBystring, <= 20 characters

Represents who Created this Campaign

modifiedBystring, <= 20 characters

Represents who was the Last to Modify this Campaign

autoRenewalboolean

Campaign subscription auto-renewal status.

billedDatestring, (date-time)

Campaign recent billed date.

brandIdstring, <= 8 characters

Alphanumeric identifier of the brand associated with this campaign.

verticalstring, <= 20 characters

Business/industry segment of this campaign. Must be of defined valid types.

useCasestring, <= 20 characters

Campaign useCase.

subUseCasesArray of strings

Campaign sub use-cases.

descriptionstring, <= 4096 characters

Summary description of this campaign.

embeddedPhoneboolean

Does message generated by the campaign include phone number in SMS?

affiliateMarketingboolean

Does message content controlled by affiliate marketing other than the brand?

numberPoolboolean

Indicates whether this campaign has been approved and configured as a numberpool campaign

ageGatedboolean

Age gated content in campaign.

directLendingboolean

is direct lending.

subscriberOptInboolean

Does campaign require subscriber to opt-in before SMS is sent to subscriber?

subscriberOptOutboolean

Does campaign support subscriber opt-out keyword(s)?

subscriberHelpboolean

Does campaign responds to help keyword(s)?

sample1string, <= 1024 characters

Message sample. Some campaign tiers require 1 or more message samples.

sample2string, <= 1024 characters

Message sample. Some campaign tiers require 2 or more message samples.

sample3string, <= 1024 characters

Message sample. Some campaign tiers require 3 or more message samples.

sample4string, <= 1024 characters

Message sample. Some campaign tiers require 4 or more message samples.

stopMessagestring, <= 255 characters

Message that will be returned if a subscriber opts out of the campaign.

optInMessagestring, <= 255 characters

Message that will be returned when a subscriber opts into a campaign.

helpMessagestring, <= 255 characters

Help message of the campaign.

monthlyFeenumber, (float)

Monthly Fee

setupFeenumber, (float)

Initial Setup Fee

statusstring, <= 32 characters

Campaign Status.

Enum ValueDescription
SINCH_REVIEW

Campaign submitted successfully and awaiting approval from Sinch.

SINCH_APPROVED

Campaign approved by Sinch.

SINCH_REJECTED

Campaign rejected by Sinch.

SUBMITTED

Campaign submitted successfully to TCR and awaiting approval from operators.

APPROVED

Campaign has been approved by the operators and is ready to be activated by adding a number to it.

ACTIVE

Campaign is active and running.

EXPIRED

Campaign is expired. Traffic cannot be sent, cannot be reactivated.

REJECTED

Campaign was rejected by one of the operators.

SUBMISSION_FAILED

Campaign submission failed.

mnoMetadataobject(Map of Metadata Map of MNO metadata where key is the 'networkId' of the MNO and value is Metadata of the MNO)
mockboolean

Defines if campaign mocked or real one

lastActionStatusstring

Last Action Status.

Enum ValueDescription
CREATE_IN_PROGRESS

Creating campaign in TCR.

CREATE_SUCCESSFUL

Campaign created in TCR.

CREATE_FAILED

Campaign creation failed in TCR.

DELETE_IN_PROGRESS

Deleting campaign in TCR.

DELETE_SUCCESSFUL

Campaign deleted in TCR.

DELETE_FAILED

Campaign deletion failed in TCR.

RESUBMIT_IN_PROGRESS

Campaign resubmission in progress.

RESUBMIT_SUCCESSFUL

Campaign resubmission completed.

RESUBMIT_FAILED

Campaign resubmission failed.

optinKeywordsstring, <= 255 characters

Subscriber opt-in keywords. Must be upper-case alphanumeric comma(,) separated keywords without space.

optoutKeywordsstring, <= 255 characters

Subscriber opt-out keywords. Default value is 'STOP'. Must be upper-case alphanumeric comma(,) separated keywords without space.

helpKeywordsstring, <= 255 characters

Subscriber help keywords. Default value is 'HELP'. Must be upper-case alphanumeric comma(,) separated keywords without space.

messageFlowstring, <= 2048 characters

Message flow description.

nextRenewalOrExpirationDatestring, (date-time)

When the campaign would be due for its next renew/bill date.

Response
{ "campaignId": "string", "campaignName": "string", "campaignRegistrationId": "string", "createDate": "2019-08-24T14:15:22Z", "modifiedDate": "2019-08-24T14:15:22Z", "createdBy": "string", "modifiedBy": "string", "autoRenewal": true, "billedDate": "2019-08-24T14:15:22Z", "brandId": "string", "vertical": "string", "useCase": "string", "subUseCases": [ "string" ], "description": "string", "embeddedLink": true, "embeddedPhone": true, "affiliateMarketing": true, "numberPool": true, "ageGated": true, "directLending": true, "subscriberOptIn": true, "subscriberOptOut": true, "subscriberHelp": true, "sample1": "string", "sample2": "string", "sample3": "string", "sample4": "string", "stopMessage": "string", "optInMessage": "string", "helpMessage": "string", "monthlyFee": 0.1, "setupFee": 0.1, "status": "SINCH_REVIEW", "mnoMetadata": { "property1": { … }, "property2": { … } }, "mock": true, "lastActionStatus": "CREATE_IN_PROGRESS", "optinKeywords": "string", "optoutKeywords": "string", "helpKeywords": "string", "messageFlow": "string", "nextRenewalOrExpirationDate": "2019-08-24T14:15:22Z" }