Jump to

• Request
• Response

Retrieve a message

get

/api/rest/2.0/assets/sms/invalidResponseMessage/{id}

Retrieves the message specified by the id parameter.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Id of the message

Query Parameters

• depth: string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : InvalidResponseMessage

Type: object

Title: InvalidResponseMessage

Show Source

• countryCodes: array countryCodes
  Country codes associated with invalid response message.
• createdAt: string
  Read Only: true

  The date and time the invalid response message was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the invalid response message.
• createdByName: string
  The name of the user who created the invalid response message.
• currentStatus: string
  The invalid response message's current status. This is a read-only property.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description: string
  The description of the invalid response message.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the invalid response message.
• id: string
  Read Only: true

  Id of the invalid response message. This is a read-only property.
• permissions: array permissions
  The permissions for the invalid response message granted to your current instance. This is a read-only property.
• response: string
  The invalid response message
• scheduledFor: string
  Read Only: true

  This property is not used.
• senderCodeId: integer
  Id of the associated sender code.
• sourceTemplateId: string
  Id of the template used to create the invalid response message.
• templateId: string
  This property is not used.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the invalid response code was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the invalid response message.
• updatedByName: string
  The name of the user who last updated the invalid response message.

{
    "title":"InvalidResponseMessage",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the invalid response message. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The invalid response message's current status. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the invalid response message."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the invalid response message granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the invalid response message."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the invalid response message."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the invalid response message."
        },
        "createdByName":{
            "type":"string",
            "description":"The name of the user who created the invalid response message."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the invalid response message was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the invalid response message."
        },
        "updatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the invalid response message."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the invalid response code was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "response":{
            "type":"string",
            "description":"The invalid response message"
        },
        "templateId":{
            "type":"string",
            "description":"This property is not used."
        },
        "senderCodeId":{
            "type":"integer",
            "description":"Id of the associated sender code."
        },
        "countryCodes":{
            "type":"array",
            "description":"Country codes associated with invalid response message.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : countryCodes

Type: array

Country codes associated with invalid response message.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Country codes associated with invalid response message.",
    "items":{
        "type":"string"
    }
}

Nested Schema : permissions

Type: array

The permissions for the invalid response message granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the invalid response message granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top