SupportDraftMessage object

Fields

Field

Type

Description

Editable

message_content

string

kind

string

settings

object

status

string

resolved_time_unix

integer

comment

string

create_user_resolved_read_time_unix

integer

created_at_unix

integer

updated_at_unix

integer

Filters

Field

Description

id

ID

resolved_user_id

created_user_id

approved

1: status が approved で絞り込み

rejected

1: status が rejected で絞り込み

resolved

1: resolved_user_id と resolved_time が空でない条件で絞り込み

in_review

1: status が in_review または空、且つ、resolved_user_id と resolved_time が空で無い条件で絞り込み

read

1: create_user_resolved_read_time が空でない条件で絞り込み 0: create_user_resolved_read_time が空の条件で絞り込み

content_or_room_name_like

message_content または関連するRoomの名前に部分一致

from_created_at

指定時刻の日付以降に作成されたデータ。IntegerのUNIX時間を設定

to_created_at

指定時刻の日付以前に作成されたデータ。IntegerのUNIX時間を設定

Run in Postman

find support draft message

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/{:id}

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "2",
    "type": "support_draft_messages",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2"
    },
    "attributes": {
      "message_content": "Message Content",
      "kind": "text",
      "settings": {},
      "status": "rejected",
      "resolved_time_unix": 1542606103,
      "comment": null,
      "create_user_resolved_read_time_unix": null,
      "created_at_unix": 1542603677,
      "updated_at_unix": 1542606103
    },
    "relationships": {
      "support": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/support",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/support"
        },
        "data": {
          "type": "supports",
          "id": "2"
        }
      },
      "resolved_user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/resolved_user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/resolved_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "created_user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/created_user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/created_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

search support draft messages

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

{
  "data": [
    {
      "id": "2",
      "type": "support_draft_messages",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2"
      },
      "attributes": {
        "message_content": "Message Content",
        "kind": "text",
        "settings": {},
        "status": "rejected",
        "resolved_time_unix": 1542606103,
        "comment": null,
        "create_user_resolved_read_time_unix": null,
        "created_at_unix": 1542603677,
        "updated_at_unix": 1542606103
      },
      "relationships": {
        "support": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/support",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/support"
          },
          "data": {
            "type": "supports",
            "id": "2"
          }
        },
        "resolved_user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/resolved_user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/resolved_user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        },
        "created_user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/created_user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/created_user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        },
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        }
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages?page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages?page%5Bnumber%5D=1&page%5Bsize%5D=25"
  }
}

create support draft message

POST https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages

Headers

Name
Type
Description

Accept

string

application/vnd.api+json

Content-Type

string

application/vnd.api+json

X-Access-Token

string

set your access token

Request Body

Name
Type
Description

data

object

{
  "data": {
    "id": "4",
    "type": "support_draft_messages",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4"
    },
    "attributes": {
      "message_content": null,
      "kind": "text",
      "settings": {},
      "status": "in_review",
      "resolved_time_unix": null,
      "comment": null,
      "create_user_resolved_read_time_unix": null,
      "created_at_unix": 1542681143,
      "updated_at_unix": 1542681143
    },
    "relationships": {
      "support": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/relationships/support",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/support"
        },
        "data": {
          "type": "supports",
          "id": "2"
        }
      },
      "resolved_user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/relationships/resolved_user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/resolved_user"
        },
        "data": null
      },
      "created_user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/relationships/created_user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/created_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/4/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

update support draft messages

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/{:id}

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

Request Body

Name
Type
Description

data

object

{
  "data": {
    "id": "2",
    "type": "support_draft_messages",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2"
    },
    "attributes": {
      "message_content": "Message Content",
      "kind": "text",
      "settings": {},
      "status": "in_review",
      "resolved_time_unix": null,
      "comment": "comment",
      "create_user_resolved_read_time_unix": null,
      "created_at_unix": 1542603677,
      "updated_at_unix": 1542681780
    },
    "relationships": {
      "support": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/support",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/support"
        },
        "data": {
          "type": "supports",
          "id": "2"
        }
      },
      "resolved_user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/resolved_user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/resolved_user"
        },
        "data": null
      },
      "created_user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/created_user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/created_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/2/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

delete support draft message

DELETE https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/{:id}

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

Completed 204 No Content

mark read all resolved

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/mark_read_all_resolved

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

{
  "data": [
    {
      "id": "4",
      "type": "support_draft_messages",
      "links": {
        "self": "/rapi/v1/support_draft_messages/4"
      },
      "attributes": {
        "message_content": null,
        "kind": "text",
        "settings": {},
        "status": "approved",
        "resolved_time_unix": null,
        "comment": null,
        "create_user_resolved_read_time_unix": 1542682190,
        "created_at_unix": 1542681143,
        "updated_at_unix": 1542682190
      },
      "relationships": {
        "support": {
          "links": {
            "self": "/rapi/v1/support_draft_messages/4/relationships/support",
            "related": "/rapi/v1/support_draft_messages/4/support"
          },
          "data": {
            "type": "supports",
            "id": "2"
          }
        },
        "resolved_user": {
          "links": {
            "self": "/rapi/v1/support_draft_messages/4/relationships/resolved_user",
            "related": "/rapi/v1/support_draft_messages/4/resolved_user"
          },
          "data": null
        },
        "created_user": {
          "links": {
            "self": "/rapi/v1/support_draft_messages/4/relationships/created_user",
            "related": "/rapi/v1/support_draft_messages/4/created_user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        },
        "room": {
          "links": {
            "self": "/rapi/v1/support_draft_messages/4/relationships/room",
            "related": "/rapi/v1/support_draft_messages/4/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        }
      }
    }
  ]
}

approve

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/{:id}/approve

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

{
  "data": {
    "id": "2",
    "type": "support_draft_messages",
    "links": {
      "self": "/rapi/v1/support_draft_messages/2"
    },
    "attributes": {
      "message_content": "Message Content",
      "kind": "text",
      "settings": {},
      "status": "approved",
      "resolved_time_unix": 1542682297,
      "comment": null,
      "create_user_resolved_read_time_unix": null,
      "created_at_unix": 1542603677,
      "updated_at_unix": 1542682297
    },
    "relationships": {
      "support": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/support",
          "related": "/rapi/v1/support_draft_messages/2/support"
        },
        "data": {
          "type": "supports",
          "id": "2"
        }
      },
      "resolved_user": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/resolved_user",
          "related": "/rapi/v1/support_draft_messages/2/resolved_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "created_user": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/created_user",
          "related": "/rapi/v1/support_draft_messages/2/created_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "room": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/room",
          "related": "/rapi/v1/support_draft_messages/2/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

reject

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/{:id}/reject

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

{
  "data": {
    "id": "2",
    "type": "support_draft_messages",
    "links": {
      "self": "/rapi/v1/support_draft_messages/2"
    },
    "attributes": {
      "message_content": "Message Content",
      "kind": "text",
      "settings": {},
      "status": "approved",
      "resolved_time_unix": 1542682297,
      "comment": null,
      "create_user_resolved_read_time_unix": null,
      "created_at_unix": 1542603677,
      "updated_at_unix": 1542682297
    },
    "relationships": {
      "support": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/support",
          "related": "/rapi/v1/support_draft_messages/2/support"
        },
        "data": {
          "type": "supports",
          "id": "2"
        }
      },
      "resolved_user": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/resolved_user",
          "related": "/rapi/v1/support_draft_messages/2/resolved_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "created_user": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/created_user",
          "related": "/rapi/v1/support_draft_messages/2/created_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "room": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/room",
          "related": "/rapi/v1/support_draft_messages/2/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

mark read

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/support_draft_messages/{:id}/mark_read

Headers

Name
Type
Description

X-Access-Token

string

set you access token

Content-Type

string

application/vnd.api+json

Accept

string

application/vnd.api+json

{
  "data": {
    "id": "2",
    "type": "support_draft_messages",
    "links": {
      "self": "/rapi/v1/support_draft_messages/2"
    },
    "attributes": {
      "message_content": "Message Content",
      "kind": "text",
      "settings": {},
      "status": "approved",
      "resolved_time_unix": 1542682297,
      "comment": null,
      "create_user_resolved_read_time_unix": 1542682346,
      "created_at_unix": 1542603677,
      "updated_at_unix": 1542682346
    },
    "relationships": {
      "support": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/support",
          "related": "/rapi/v1/support_draft_messages/2/support"
        },
        "data": {
          "type": "supports",
          "id": "2"
        }
      },
      "resolved_user": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/resolved_user",
          "related": "/rapi/v1/support_draft_messages/2/resolved_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "created_user": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/created_user",
          "related": "/rapi/v1/support_draft_messages/2/created_user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "room": {
        "links": {
          "self": "/rapi/v1/support_draft_messages/2/relationships/room",
          "related": "/rapi/v1/support_draft_messages/2/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}
前へUserEvent object次へUser object

最終更新