Support object

Fields

Field	Type	Description	Editable
end_time_unix	integer
start_time_unix	integer

Filters

Field	Description
id	ID
active_or_end_time_gt	end_time が指定時刻以降、または空のサポート。IntegerのUNIX時間を設定
to	start_time が指定時刻の日付以前、または end_time が空のサポート。IntegerのUNIX時間を設定
from	end_time が指定時刻の日付以降、または空のサポート。IntegerのUNIX時間を設定
room_or_operator	Roomの名前、部屋に関連するUserの email, name, full_name のいずれかに部分一致
active	1: end_time が空のサポート。 2: end_time が空ではないサポート。
status	active: end_time が空のサポート。 ended: end_time が空ではないサポート。
user_id	UserのID
room_id	RoomのID
replied	end_time が空で、関連するRoomに接客者が返信しているか。 1: 返信済 0: 未返信

find support

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/{: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

200

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

{
  "data": {
    "id": "2",
    "type": "supports",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2"
    },
    "attributes": {
      "end_time_unix": null,
      "start_time_unix": 1542603555
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      },
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "latest_message": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/latest_message",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/latest_message"
        },
        "data": {
          "type": "messages",
          "id": "2"
        }
      },
      "customer": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/customer",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/customer"
        },
        "data": {
          "type": "users",
          "id": "2"
        }
      },
      "members": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/members",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/members"
        },
        "data": [
          {
            "type": "members",
            "id": "1"
          },
          {
            "type": "members",
            "id": "3"
          },
          {
            "type": "members",
            "id": "8"
          }
        ]
      }
    }
  }
}

search supports

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

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

200

{
  "data": [
    {
      "id": "2",
      "type": "supports",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2"
      },
      "attributes": {
        "end_time_unix": null,
        "start_time_unix": 1542603555
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        },
        "latest_message": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/latest_message",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/latest_message"
          },
          "data": {
            "type": "messages",
            "id": "2"
          }
        },
        "customer": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/customer",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/customer"
          },
          "data": {
            "type": "users",
            "id": "2"
          }
        },
        "members": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/members",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/members"
          },
          "data": [
            {
              "type": "members",
              "id": "1"
            },
            {
              "type": "members",
              "id": "3"
            },
            {
              "type": "members",
              "id": "8"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports?page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports?page%5Bnumber%5D=1&page%5Bsize%5D=25"
  }
}

search

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/search

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

200

export

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/export

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

200

id,room_id,room_name,start_time,end_time,user_id,user_name
1,3,kiwi-barren-cabbage-1-wbbRxtFEf9E,2018/11/08 17:53,,1,Manager

end support

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/end_support

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

200

{
  "data": {
    "id": "2",
    "type": "supports",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2"
    },
    "attributes": {
      "end_time_unix": 1542679562,
      "start_time_unix": 1542603555
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      },
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "latest_message": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/latest_message",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/latest_message"
        },
        "data": {
          "type": "messages",
          "id": "2"
        }
      },
      "customer": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/customer",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/customer"
        },
        "data": {
          "type": "users",
          "id": "2"
        }
      },
      "members": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/members",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/members"
        },
        "data": [
          {
            "type": "members",
            "id": "1"
          },
          {
            "type": "members",
            "id": "3"
          },
          {
            "type": "members",
            "id": "8"
          }
        ]
      }
    }
  }
}

reassign

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/reassign

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

200

{
  "data": [
    {
      "id": "3",
      "type": "supports",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3"
      },
      "attributes": {
        "end_time_unix": null,
        "start_time_unix": 1542679579
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        },
        "latest_message": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/relationships/latest_message",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/latest_message"
          },
          "data": {
            "type": "messages",
            "id": "2"
          }
        },
        "customer": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/relationships/customer",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/customer"
          },
          "data": {
            "type": "users",
            "id": "2"
          }
        },
        "members": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/relationships/members",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/3/members"
          },
          "data": [
            {
              "type": "members",
              "id": "1"
            },
            {
              "type": "members",
              "id": "3"
            },
            {
              "type": "members",
              "id": "8"
            }
          ]
        }
      }
    },
    {
      "id": "2",
      "type": "supports",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2"
      },
      "attributes": {
        "end_time_unix": 1542679562,
        "start_time_unix": 1542603555
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        },
        "latest_message": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/latest_message",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/latest_message"
          },
          "data": {
            "type": "messages",
            "id": "2"
          }
        },
        "customer": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/customer",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/customer"
          },
          "data": {
            "type": "users",
            "id": "2"
          }
        },
        "members": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/relationships/members",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/2/members"
          },
          "data": [
            {
              "type": "members",
              "id": "1"
            },
            {
              "type": "members",
              "id": "3"
            },
            {
              "type": "members",
              "id": "8"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "record_count": 2
  },
  "links": {
    "first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports?page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports?page%5Bnumber%5D=1&page%5Bsize%5D=25"
  }
}

reopen

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/reopen

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

200

{
  "data": {
    "id": "4",
    "type": "supports",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4"
    },
    "attributes": {
      "end_time_unix": null,
      "start_time_unix": 1542679622
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      },
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      },
      "latest_message": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/relationships/latest_message",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/latest_message"
        },
        "data": {
          "type": "messages",
          "id": "2"
        }
      },
      "customer": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/relationships/customer",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/customer"
        },
        "data": {
          "type": "users",
          "id": "2"
        }
      },
      "members": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/relationships/members",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/supports/4/members"
        },
        "data": [
          {
            "type": "members",
            "id": "1"
          },
          {
            "type": "members",
            "id": "3"
          },
          {
            "type": "members",
            "id": "8"
          }
        ]
      }
    }
  }
}