List campaigns

GET

https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/:id/campaigns

GET

/api/relay/rest/registry/beta/brands/:id/campaigns

$ curl https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands/id/campaigns \
>      -u "<project_id>:<api_token>"

1 {
2   "links": {
3     "self": "string",
4     "first": "string",
5     "next": "string",
6     "prev": "string"
7   },
8   "data": [
9     {
10       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11       "name": "My Campaign",
12       "state": "pending",
13       "sms_use_case": "MARKETING",
14       "sub_use_cases": [
15         "string"
16       ],
17       "campaign_verify_token": "string",
18       "description": "string",
19       "sample1": "this is a sample message your customer might receive",
20       "sample2": "this is a sample message your customer might receive",
21       "sample3": "string",
22       "sample4": "string",
23       "sample5": "string",
24       "dynamic_templates": "string",
25       "message_flow": "Users will opt in to receive messages from their doctor through a written form and we will send them an opt in message. Appointment reminders will then be sent ahead of their appointments.",
26       "opt_in_message": "Thanks for subscribing. Reply STOP to cancel at any time.",
27       "opt_out_message": "You have successfully been opted out. Reply START to opt back in at any time.",
28       "help_message": "You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.",
29       "opt_in_keywords": "Start,Subscribe,Opt In",
30       "opt_out_keywords": "Stop,Opt Out,Unsubscribe",
31       "help_keywords": "Help,Support,Request Call",
32       "number_pooling_required": true,
33       "number_pooling_per_campaign": "We have customer reps in every state and they each need their own number with local area code.",
34       "direct_lending": true,
35       "embedded_link": false,
36       "embedded_phone": false,
37       "age_gated_content": true,
38       "lead_generation": true,
39       "csp_campaign_reference": "1231231",
40       "status_callback_url": "https://example.com/handle_callback",
41       "created_at": "2024-01-15T09:30:00Z",
42       "updated_at": "2024-01-15T09:30:00Z"
43     }
44   ]
45 }

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging and Numbers.

Learn more about API scopes.

Lists the US 10-digit long code (10DLC) messaging campaigns registered under one brand. Each campaign represents an approved messaging use case to which project phone numbers can be assigned. Use [Get campaign](/docs/apis/rest/campaign-registry/campaigns/retrieve-campaign) when you already have a campaign ID. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Messaging_ and _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the brand.

Query parameters

filter_namestringOptional

The name given to the campaign. Will return all Campaigns containing this value as a substring.

filter_statestringOptional

The state of the campaign in the registration process, such as pending or complete. Will return all campaigns with this value.

Response

The request has succeeded.

linksobjectOptional

Pagination links.

datalist of objectsOptional

List of campaigns.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error