List Request Messages

client.CloudforceOne.Requests.Message.Get(ctx, requestID, params) (*SinglePage[Message], error)

POST/accounts/{account_id}/cloudforce-one/requests/{request_id}/message

Lists messages in a Cloudforce One intelligence request conversation.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Cloudforce One Write

ParametersExpand Collapse

requestID string

UUID.

maxLength36

params RequestMessageGetParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

Page param.Field[int64]

Body param: Page number of results.

PerPage param.Field[int64]

Body param: Number of results per page.

After param.Field[Time]Optional

Body param: Retrieve mes ges created after this time.

formatdate-time

Before param.Field[Time]Optional

Body param: Retrieve messages created before this time.

formatdate-time

SortBy param.Field[string]Optional

Body param: Field to sort results by.

SortOrder param.Field[RequestMessageGetParamsSortOrder]Optional

Body param: Sort order (asc or desc).

const RequestMessageGetParamsSortOrderAsc RequestMessageGetParamsSortOrder = "asc"

const RequestMessageGetParamsSortOrderDesc RequestMessageGetParamsSortOrder = "desc"

ReturnsExpand Collapse

type Message struct{…}

ID int64

Message ID.

Author string

Author of message.

Content string

Content of message.

IsFollowOnRequest bool

Whether the message is a follow-on request.

Updated Time

Defines the message last updated time.

formatdate-time

Created TimeOptional

Defines the message creation time.

formatdate-time

List Request Messages

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/cloudforce_one"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.CloudforceOne.Requests.Message.Get(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    cloudforce_one.RequestMessageGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      Page: cloudflare.F(int64(0)),
      PerPage: cloudflare.F(int64(10)),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": 0,
      "author": "user@domain.com",
      "content": "Can you elaborate on the type of DoS that occurred?",
      "is_follow_on_request": true,
      "updated": "2022-01-01T00:00:00Z",
      "created": "2022-01-01T00:00:00Z"
    }
  ]
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": 0,
      "author": "user@domain.com",
      "content": "Can you elaborate on the type of DoS that occurred?",
      "is_follow_on_request": true,
      "updated": "2022-01-01T00:00:00Z",
      "created": "2022-01-01T00:00:00Z"
    }
  ]
}