Sha256: bc93205ea50c6b3dc536da5e1a2525241462bf03503849c94f0e267b5d59d614
Contents?: true
Size: 1.02 KB
Versions: 10
Compression:
Stored size: 1.02 KB
Contents
module ChatWork::Client::ContactsMethods
# Get the list of your contacts
#
# @see http://developer.chatwork.com/ja/endpoint_contacts.html#GET-contacts
# @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
#
# @yield [response_body, response_header] if block was given, return response body and response header through block arguments
# @yieldparam response_body [Array<Hashie::Mash>] response body
# @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
#
# @return [Array<Hashie::Mash>]
#
# @example response format
# [
# {
# "account_id": 123,
# "room_id": 322,
# "name": "John Smith",
# "chatwork_id": "tarochatworkid",
# "organization_id": 101,
# "organization_name": "Hello Company",
# "department": "Marketing",
# "avatar_image_url": "https://example.com/abc.png"
# }
# ]
def get_contacts(&block)
get("/contacts", &block)
end
end
Version data entries
10 entries across 10 versions & 1 rubygems