Get Campaign Mno Metadata

GET 
/campaign/:campaignId/mnoMetadata

Get the campaign metadata for each MNO it was submitted to.

Request

Path Parameters

campaignId Campaignidrequired

ID of the campaign in question

Responses

200: Successful Response. It constains a map of usecase metadata for each MNO. The key is the network ID of the MNO (e.g. 10017), the value is the mno metadata for the usecase. The metadata may also include some MNO specific fields.

application/json

• Schema
• Example (from schema)

Schema

10999

object

qualify booleanrequired

mno stringrequired

noEmbeddedLink booleanrequired

reqSubscriberHelp booleanrequired

reqSubscriberOptout booleanrequired

mnoReview booleanrequired

noEmbeddedPhone booleanrequired

mnoSupport booleanrequired

reqSubscriberOptin booleanrequired

minMsgSamples integerrequired

{
  "10999": {
    "qualify": true,
    "mno": "string",
    "noEmbeddedLink": true,
    "reqSubscriberHelp": true,
    "reqSubscriberOptout": true,
    "mnoReview": true,
    "noEmbeddedPhone": true,
    "mnoSupport": true,
    "reqSubscriberOptin": true,
    "minMsgSamples": 1
  }
}

default: Unexpected Error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}

Loading...