API Token and API Interface<\/h2>\n\n\n\nObtaining an API Token from the administration screen<\/h3>\n\n\n\n\n\nWhen performing API linkage, first obtain an API Token.<\/p>\n\n\n\n
Pass the obtained apiToken \/ serverURL to JavaScript \/ curl as described in \"API Interface\" below.<\/p>\n<\/div>\n\n\n\n
\n![\"\"](\"https:\/\/chat-messenger.com\/wp-content\/uploads\/2024\/11\/image.png\")
<\/figure>\n\n\n\nAPI Interface<\/h3>\n\n\n\n
The API interface can be used with JavaScript, curl command line, or any HTTP access program. Both of the following samples can retrieve conference room registration information in JSON format.<\/p>\n\n\n\n
In an environment where regular SSL is not applied, the server URL will be HTTP port 8080.<\/p>\n\n\n\n
JavaScript<\/h4>\n\n\n\nlet config = {\n\t"apiToken": "QIQVOSvRJHrQElDwj20x******",\n\t"serverURL": "https:\/\/*****************"\n}\nlet client = new CAMAPIClient(config);\nlet response = await client.getConferenceRooms();<\/code><\/pre><\/div>\n\n\n\ncurl command line<\/h4>\n\n\n\ncurl -H "x-cam-apiToken:token******" ${serverURL}\/getConferenceRooms<\/code><\/pre><\/div>\n\n\n\nAny HTTP access program<\/h4>\n\n\n\n
Any HTTP access program can be used. API execution is Content-Type<\/code> indicates object of desire, like, hate, etc. application\/x-www-form-urlencoded<\/code> Then send it via POST.<\/p>\n\n\n\nAPI Sample Screens<\/h3>\n\n\n\n
We have a sample URL where you can easily test API execution. If you would like to use it for testing, please contact us through Contact Us.<\/p>\n\n\n
\n![\"\"](\"https:\/\/chat-messenger.com\/images\/api_sample_page.jpg\")
<\/figure><\/div>\n\n\n\n\n\n\nMessage API<\/h2>\n\n\n\nsendMessage<\/h3>\n\n\n\n
Send a message.<\/p>\n\n\n\n
sample<\/h4>\n\n\n\nSend by messenger with user ID<\/h5>\n\n\n\nlet response = await getAPIClient().sendMessage(\n\t"messenger", \t\/\/ messenger \u3092\u6307\u5b9a\u3057\u305f\u30c0\u30a4\u30ec\u30af\u30c8\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u6307\u5b9a\n\t"Hello!", \t\/\/ \u9001\u4fe1\u3059\u308b\u30e1\u30c3\u30bb\u30fc\u30b8\n\tfalse, \t\/\/ \u5c01\u66f8\u306f off \n\t["user1@xxx.com", "user2@xxx.com"]\t\/\/ \u5b9b\u5148 Email \u30a2\u30c9\u30ec\u30b9 \n\t);<\/code><\/pre><\/div>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d message="{\\"panelName\\":\\"messenger\\",\\"message\\":\\"Hello\\",\\"isOpened\\":false,\\"generalPurposes\\":{\\"users\\":\\"user1@xxx.com,user2@xxx.com\\"}}" ${serverURL}\/sendMessage<\/code><\/pre><\/div>\n\n\n\nSend by specifying a chat room<\/h5>\n\n\n\nlet response = await getAPIClient().sendMessage(\n\t"\u30eb\u30fc\u30e0\u540d", \n\t"Hello!", \n\tfalse,\n ["user1@xxx.com", "user2@xxx.com"]\t\/\/ \u30e1\u30f3\u30b7\u30e7\u30f3\u3068\u3057\u3066 Email \u30a2\u30c9\u30ec\u30b9\u6307\u5b9a \n);<\/code><\/pre><\/div>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d message="{\\"panelName\\":\\"\u30eb\u30fc\u30e0\u540d\\",\\"message\\":\\"Hello\\",\\"isOpened\\":false,\\"generalPurposes\\":{\\"users\\":\\"user1@xxx.com,user2@xxx.com\\"}}" ${serverURL}\/sendMessage<\/code><\/pre><\/div>\n\n\n\nargument (e.g. function, program, programme)<\/h4>\n\n\n\n<\/tr> send<\/td> - Specify the target for transmission <\/li>
- For messenger, specify messenger; for chat, specify the room name.<\/li><\/ul><\/td><\/tr>
users<\/td> - If send is messenger, to the destination user. If it is a chat room, it is notified by Mention after sharing the whole chat room. <\/li>
- Search for a user by Email address<\/li>
- When sending multiple emails, specify , as the Email delimiter.<\/li><\/ul><\/td><\/tr>
message<\/td> - Specify the message to be sent <\/li>
- To break a line of text, insert the line feed code \\n<\/li><\/ul><\/td><\/tr>
seal<\/td> - Specify true \/ false. Send with opening confirmation<\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
sendMessages<\/h3>\n\n\n\n
Sends a batch message from a json file.<\/p>\n\n\n\n
json files should be saved with the character code UTF8.<\/p>\n\n\n\n
sample<\/h4>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d @messages.json\u00a0${serverURL}\/sendMessages <\/code><\/pre><\/div>\n\n\n\nmessages=[\n {"message":"\u3053\u3093\u306b\u3061\u306f 1","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 2","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 3","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 4","property":{"users":"user1@test.com,user2@test.com"}},\n]<\/code><\/pre><\/div>\n\n\n\nmessages=[\n {"send": "test", "message":"\u30c6\u30b9\u30c8 1"}\n]<\/code><\/pre><\/div>\n\n\n\nCall API<\/h2>\n\n\n\n
When performing API linkage, first obtain an API Token.<\/p>\n\n\n\n
Pass the obtained apiToken \/ serverURL to JavaScript \/ curl as described in \"API Interface\" below.<\/p>\n<\/div>\n\n\n\n
<\/figure>\n\n\n\nAPI Interface<\/h3>\n\n\n\n
The API interface can be used with JavaScript, curl command line, or any HTTP access program. Both of the following samples can retrieve conference room registration information in JSON format.<\/p>\n\n\n\n
In an environment where regular SSL is not applied, the server URL will be HTTP port 8080.<\/p>\n\n\n\n
JavaScript<\/h4>\n\n\n\nlet config = {\n\t"apiToken": "QIQVOSvRJHrQElDwj20x******",\n\t"serverURL": "https:\/\/*****************"\n}\nlet client = new CAMAPIClient(config);\nlet response = await client.getConferenceRooms();<\/code><\/pre><\/div>\n\n\n\ncurl command line<\/h4>\n\n\n\ncurl -H "x-cam-apiToken:token******" ${serverURL}\/getConferenceRooms<\/code><\/pre><\/div>\n\n\n\nAny HTTP access program<\/h4>\n\n\n\n
Any HTTP access program can be used. API execution is Content-Type<\/code> indicates object of desire, like, hate, etc. application\/x-www-form-urlencoded<\/code> Then send it via POST.<\/p>\n\n\n\nAPI Sample Screens<\/h3>\n\n\n\n
We have a sample URL where you can easily test API execution. If you would like to use it for testing, please contact us through Contact Us.<\/p>\n\n\n
\n<\/figure><\/div>\n\n\n\n\n\n\nMessage API<\/h2>\n\n\n\nsendMessage<\/h3>\n\n\n\n
Send a message.<\/p>\n\n\n\n
sample<\/h4>\n\n\n\nSend by messenger with user ID<\/h5>\n\n\n\nlet response = await getAPIClient().sendMessage(\n\t"messenger", \t\/\/ messenger \u3092\u6307\u5b9a\u3057\u305f\u30c0\u30a4\u30ec\u30af\u30c8\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u6307\u5b9a\n\t"Hello!", \t\/\/ \u9001\u4fe1\u3059\u308b\u30e1\u30c3\u30bb\u30fc\u30b8\n\tfalse, \t\/\/ \u5c01\u66f8\u306f off \n\t["user1@xxx.com", "user2@xxx.com"]\t\/\/ \u5b9b\u5148 Email \u30a2\u30c9\u30ec\u30b9 \n\t);<\/code><\/pre><\/div>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d message="{\\"panelName\\":\\"messenger\\",\\"message\\":\\"Hello\\",\\"isOpened\\":false,\\"generalPurposes\\":{\\"users\\":\\"user1@xxx.com,user2@xxx.com\\"}}" ${serverURL}\/sendMessage<\/code><\/pre><\/div>\n\n\n\nSend by specifying a chat room<\/h5>\n\n\n\nlet response = await getAPIClient().sendMessage(\n\t"\u30eb\u30fc\u30e0\u540d", \n\t"Hello!", \n\tfalse,\n ["user1@xxx.com", "user2@xxx.com"]\t\/\/ \u30e1\u30f3\u30b7\u30e7\u30f3\u3068\u3057\u3066 Email \u30a2\u30c9\u30ec\u30b9\u6307\u5b9a \n);<\/code><\/pre><\/div>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d message="{\\"panelName\\":\\"\u30eb\u30fc\u30e0\u540d\\",\\"message\\":\\"Hello\\",\\"isOpened\\":false,\\"generalPurposes\\":{\\"users\\":\\"user1@xxx.com,user2@xxx.com\\"}}" ${serverURL}\/sendMessage<\/code><\/pre><\/div>\n\n\n\nargument (e.g. function, program, programme)<\/h4>\n\n\n\n<\/tr> send<\/td> - Specify the target for transmission <\/li>
- For messenger, specify messenger; for chat, specify the room name.<\/li><\/ul><\/td><\/tr>
users<\/td> - If send is messenger, to the destination user. If it is a chat room, it is notified by Mention after sharing the whole chat room. <\/li>
- Search for a user by Email address<\/li>
- When sending multiple emails, specify , as the Email delimiter.<\/li><\/ul><\/td><\/tr>
message<\/td> - Specify the message to be sent <\/li>
- To break a line of text, insert the line feed code \\n<\/li><\/ul><\/td><\/tr>
seal<\/td> - Specify true \/ false. Send with opening confirmation<\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
sendMessages<\/h3>\n\n\n\n
Sends a batch message from a json file.<\/p>\n\n\n\n
json files should be saved with the character code UTF8.<\/p>\n\n\n\n
sample<\/h4>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d @messages.json\u00a0${serverURL}\/sendMessages <\/code><\/pre><\/div>\n\n\n\nmessages=[\n {"message":"\u3053\u3093\u306b\u3061\u306f 1","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 2","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 3","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 4","property":{"users":"user1@test.com,user2@test.com"}},\n]<\/code><\/pre><\/div>\n\n\n\nmessages=[\n {"send": "test", "message":"\u30c6\u30b9\u30c8 1"}\n]<\/code><\/pre><\/div>\n\n\n\nCall API<\/h2>\n\n\n\n
let config = {\n\t"apiToken": "QIQVOSvRJHrQElDwj20x******",\n\t"serverURL": "https:\/\/*****************"\n}\nlet client = new CAMAPIClient(config);\nlet response = await client.getConferenceRooms();<\/code><\/pre><\/div>\n\n\n\ncurl command line<\/h4>\n\n\n\ncurl -H "x-cam-apiToken:token******" ${serverURL}\/getConferenceRooms<\/code><\/pre><\/div>\n\n\n\nAny HTTP access program<\/h4>\n\n\n\n
Any HTTP access program can be used. API execution is Content-Type<\/code> indicates object of desire, like, hate, etc. application\/x-www-form-urlencoded<\/code> Then send it via POST.<\/p>\n\n\n\nAPI Sample Screens<\/h3>\n\n\n\n
We have a sample URL where you can easily test API execution. If you would like to use it for testing, please contact us through Contact Us.<\/p>\n\n\n
\n<\/figure><\/div>\n\n\n\n\n\n\nMessage API<\/h2>\n\n\n\nsendMessage<\/h3>\n\n\n\n
Send a message.<\/p>\n\n\n\n
sample<\/h4>\n\n\n\nSend by messenger with user ID<\/h5>\n\n\n\nlet response = await getAPIClient().sendMessage(\n\t"messenger", \t\/\/ messenger \u3092\u6307\u5b9a\u3057\u305f\u30c0\u30a4\u30ec\u30af\u30c8\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u6307\u5b9a\n\t"Hello!", \t\/\/ \u9001\u4fe1\u3059\u308b\u30e1\u30c3\u30bb\u30fc\u30b8\n\tfalse, \t\/\/ \u5c01\u66f8\u306f off \n\t["user1@xxx.com", "user2@xxx.com"]\t\/\/ \u5b9b\u5148 Email \u30a2\u30c9\u30ec\u30b9 \n\t);<\/code><\/pre><\/div>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d message="{\\"panelName\\":\\"messenger\\",\\"message\\":\\"Hello\\",\\"isOpened\\":false,\\"generalPurposes\\":{\\"users\\":\\"user1@xxx.com,user2@xxx.com\\"}}" ${serverURL}\/sendMessage<\/code><\/pre><\/div>\n\n\n\nSend by specifying a chat room<\/h5>\n\n\n\nlet response = await getAPIClient().sendMessage(\n\t"\u30eb\u30fc\u30e0\u540d", \n\t"Hello!", \n\tfalse,\n ["user1@xxx.com", "user2@xxx.com"]\t\/\/ \u30e1\u30f3\u30b7\u30e7\u30f3\u3068\u3057\u3066 Email \u30a2\u30c9\u30ec\u30b9\u6307\u5b9a \n);<\/code><\/pre><\/div>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d message="{\\"panelName\\":\\"\u30eb\u30fc\u30e0\u540d\\",\\"message\\":\\"Hello\\",\\"isOpened\\":false,\\"generalPurposes\\":{\\"users\\":\\"user1@xxx.com,user2@xxx.com\\"}}" ${serverURL}\/sendMessage<\/code><\/pre><\/div>\n\n\n\nargument (e.g. function, program, programme)<\/h4>\n\n\n\n<\/tr> send<\/td> - Specify the target for transmission <\/li>
- For messenger, specify messenger; for chat, specify the room name.<\/li><\/ul><\/td><\/tr>
users<\/td> - If send is messenger, to the destination user. If it is a chat room, it is notified by Mention after sharing the whole chat room. <\/li>
- Search for a user by Email address<\/li>
- When sending multiple emails, specify , as the Email delimiter.<\/li><\/ul><\/td><\/tr>
message<\/td> - Specify the message to be sent <\/li>
- To break a line of text, insert the line feed code \\n<\/li><\/ul><\/td><\/tr>
seal<\/td> - Specify true \/ false. Send with opening confirmation<\/li><\/ul><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
sendMessages<\/h3>\n\n\n\n
Sends a batch message from a json file.<\/p>\n\n\n\n
json files should be saved with the character code UTF8.<\/p>\n\n\n\n
sample<\/h4>\n\n\n\ncurl -H "x-cam-apiToken:token******" -d @messages.json\u00a0${serverURL}\/sendMessages <\/code><\/pre><\/div>\n\n\n\nmessages=[\n {"message":"\u3053\u3093\u306b\u3061\u306f 1","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 2","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 3","property":{"users":"user1@test.com,user2@test.com"}},\n {"message":"\u3053\u3093\u306b\u3061\u306f 4","property":{"users":"user1@test.com,user2@test.com"}},\n]<\/code><\/pre><\/div>\n\n\n\nmessages=[\n {"send": "test", "message":"\u30c6\u30b9\u30c8 1"}\n]<\/code><\/pre><\/div>\n\n\n\nCall API<\/h2>\n\n\n\n