Detalles de la campaña

Use el id para recuperar detalles de una campaña en particular en Engage.

Endpoint y métodos
GET: /api/v2/campaigns/:id
 
Parámetros

Respuesta código 200 devuelve un objeto de campaña.

{
  "campaignName": "Texas SMS Test",
  "campaignId": "5c1097c6717a743602510c9c",
  "campaignDescription": "This is a Texas SMS test",
  "callerIdentification": "+13122735567",
  "flowTypeId": "5d24c0e64886e81bb4cbf069",
  "startDate": "2019-06-18",
  "endDate": "2019-06-18",
  "active": 1,
  "numAttempts": "5",
  "retryInterval": "10",
  "appId": "",
  "runNow": "true",
  "scheduleId": "5f24c065jkl0p81bb4cbf069",
  "modifiedDate": "2019-06-18T00:14:03Z",
  "modifiedBy": "sspeirs",
  "createdDate": "2019-06-18T00:14:03Z",
  "createdBy": "sspeirs",
  "deleteFlag": "false",
  "customerId": 9999999,
  "listRel": [
    "4kk11065jkl0985bb48mf054"
  ],
  "utcName": "United States Minor Outlying Islands - Baker Island",
  "utcOffset": "−12:00"
}

Respuesta código 401 devuelve un error que indica que el token de autorización no es válido.

{
"message": "string",
"status": 401
}

Respuesta código 422 devuelve un mensaje que se requiere el parámetro id.

[ 
"message": "The 'id' parameter is required",
"status": 422
}

Respuesta código 500 devuelve un error al intentar ejecutar la campaña.

{
  "message": "Something went wrong when trying to get campaign details",
  "status": 500
}