Returns the specified campaign by its TCR Campaign ID.
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.
- HTTP 10DLC API Server (Default(US))https://us10dlc.numbers.api.sinch.com/v1/projects/{projectId}/campaignRegistrations:fetchByTcrCampaignId
curl -i -X GET \
-u '<username>:<password>' \
'https://us10dlc.numbers.api.sinch.com/v1/projects/{projectId}/campaignRegistrations:fetchByTcrCampaignId?campaignRegistrationIdQuery=string'A successful response.
Campaign Registration Id returned by the Create Campaign API
Business/industry segment of this campaign. Must be of defined valid types.
Does message content controlled by affiliate marketing other than the brand?
Indicates whether this campaign has been approved and configured as a numberpool campaign
Message sample. Some campaign tiers require 1 or more message samples.
Message sample. Some campaign tiers require 2 or more message samples.
Message sample. Some campaign tiers require 3 or more message samples.
Message sample. Some campaign tiers require 4 or more message samples.
Message that will be returned if a subscriber opts out of the campaign.
Message that will be returned when a subscriber opts into a campaign.
Campaign Status.
| Enum Value | Description |
|---|---|
| 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. |
Last Action Status.
| Enum Value | Description |
|---|---|
| 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. |
Subscriber opt-in keywords. Must be upper-case alphanumeric comma(,) separated keywords without space.
Subscriber opt-out keywords. Default value is 'STOP'. Must be upper-case alphanumeric comma(,) separated keywords without space.
Subscriber help keywords. Default value is 'HELP'. Must be upper-case alphanumeric comma(,) separated keywords without space.
{ "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" }