SIsinch
10DLC Campaign Registration

Get Campaign Details using the TCR Campaign ID

Returns the specified campaign by its TCR Campaign ID.

get/v1/projects/{projectId}/campaignRegistrations:fetchByTcrCampaignId

Request

  • Base URL
    https://us10dlc.numbers.api.sinch.com
  • URL
    https://us10dlc.numbers.api.sinch.com/v1/projects/{projectId}/campaignRegistrations:fetchByTcrCampaignId
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required

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 parameters

campaignRegistrationIdQuerystring required

Campaign Registration Id returned by the create campaign API.

Response

A successful response.

campaignIdstring

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

campaignNamestring

Optional name to help track and view campaign.

campaignRegistrationIdstring

Campaign Registration Id returned by the Create Campaign API

createDatestring date-time

Campaign Creation Date

modifiedDatestring date-time

Campaign Modified Date

createdBystring

Represents who Created this Campaign

modifiedBystring

Represents who was the Last to Modify this Campaign

autoRenewalboolean

Campaign subscription auto-renewal status.

billedDatestring date-time

Campaign recent billed date.

brandIdstring

Alphanumeric identifier of the brand associated with this campaign.

verticalstring

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

useCasestring

Campaign useCase.

subUseCasesstring[]

Campaign sub use-cases.

descriptionstring

Summary description of this campaign.

embeddedLinkboolean

Does message generated by the campaign include URL link in SMS?

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

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

sample2string

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

sample3string

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

sample4string

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

stopMessagestring

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

optInMessagestring

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

helpMessagestring

Help message of the campaign.

monthlyFeenumber float

Monthly Fee

setupFeenumber float

Initial Setup Fee

status'SINCH_REVIEW' | 'SINCH_APPROVED' | 'SINCH_REJECTED' | 'SUBMITTED' | 'APPROVED' | 'ACTIVE' | 'EXPIRED' | 'REJECTED' | 'SUBMISSION_FAILED'

Campaign Status.

mnoMetadataobject
mockboolean

Defines if campaign mocked or real one

lastActionStatus'CREATE_IN_PROGRESS' | 'CREATE_SUCCESSFUL' | 'CREATE_FAILED' | 'DELETE_IN_PROGRESS' | 'DELETE_SUCCESSFUL' | 'DELETE_FAILED' | 'RESUBMIT_IN_PROGRESS' | 'RESUBMIT_SUCCESSFUL' | 'RESUBMIT_FAILED'

Last Action Status.

optinKeywordsstring

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

optoutKeywordsstring

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

helpKeywordsstring

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

messageFlowstring

Message flow description.

nextRenewalOrExpirationDatestring date-time

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

Changes

No recorded changes to this operation across all 5 revisions of this API.