smooch-core

2019-05-15 admin

smooch-core是什么

什么是smooch-core,Javascript wrapper for Smooch API

smooch-core使用教程帮助文档

Smooch Core

Smooch Core is the most basic for interaction possible for the Smooch API. It wraps the public API in a convenient Javascript API.

This library is meant to be used server-side with Node.js.

Installation

$ npm install smooch-core --save

Contributing

If a method is missing please file an Issue, or better yet make a PR!

Smooch API Version

The Smooch API offers multiple versions. Each release of this project targets one and only one Smooch API version. If you depend on an older version of the Smooch API, you may need to use an older release of this library. Use the table below as your guide:

Smooch API version smooch-core version to use
v1.1 Upgrade guide 8.0.0 or newer
v1 7.* or older

Usage

var SmoochCore = require('smooch-core');

// using generated JWT
var smooch = new SmoochCore({
    jwt: 'some-jwt'
});

// using JWT components
var smooch = new SmoochCore({
    keyId: 'some-key',
    secret: 'some-secret',
    scope: 'appUser', // account, app, or appUser
    userId: 'some-id' // only required for appUser scope
});

// ...

smooch.webhooks.get(id).then(function(response) {
    // do something with the response.
});

Usage with a proxy

If you need to use a proxy, you can use one of the many proxies available, as long as it an http.Agent implementation. You only need to pass the agent when creating the SmoochCore instance.

var SmoochCore = require('smooch-core');
var SocksProxyAgent = require('socks-proxy-agent');
var proxy = process.env.http_proxy || 'socks://localhost:8123';
var agent = new SocksProxyAgent(proxy);

var smooch = new SmoochCore({
    keyId: 'some-key',
    secret: 'some-secret',
    httpAgent: agent
});

API

Below is a list of methods included in Smooch Core. For comprehensive documentation of Smooch Core and its methods see Smooch’s REST API docs.

For more detailed information and example usage of each of the following methods, click on the method’s <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji> icon.

Method Description Link
appUsers Module
appUsers.get Get a specific appUser. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.update Update an appUser’s basic profile information and specify custom profile data. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.delete Delete an appUser. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.deleteProfile Delete an appUser’s profile. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.create Pre-create an appUser object before that appUser runs your app for the first time. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.linkChannel Link appUser to continue conversation on his/her preferred channel. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.unlinkChannel Remove the specified channel from the appUser’s clients. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.getMessages Get the specified appUser’s conversation history. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.resetUnreadCount Reset the unread count of the conversation to 0. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.typingActivity Notify Smooch when an app maker starts or stops typing a response. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.sendMessage Post a message to or from the appUser. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.deleteMessage Delete a single message. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.deleteMessages Clears the message history for an appUser, permanently deleting all messages. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.getChannels Get all of the appUser’s channel entity Ids. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.getBusinessSystems Get all the business systems to which an appUser’s conversation is connected. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.getAuthCode Get auth code. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
appUsers.getLinkRequests Generate a transfer URL for a given channel type. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
menu Module
menu.get Get the specified app’s menu. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
menu.configure Configure the specified app’s menu. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
menu.remove Remove the specified app’s menu. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
webhooks Module
webhooks.list List all webhooks configured for a given app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
webhooks.create Create a webhook for the specified app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
webhooks.get Get individual webhooks. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
webhooks.update Update existing webhooks. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
webhooks.delete Delete specified webhook. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps Module
apps.create Create a new app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.list List all configured apps. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.get Get the specified app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.delete Delete the specified app, including all its enabled integrations. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.keys.create Create a secret key for the specified app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.keys.list List all secret keys for the sepcified app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.keys.get Get a secret key. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.keys.delete Delete a secret key. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
apps.keys.getJwt Get an app-scoped JWT signed using the requested keyId/secret pair. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations Module
integrations.create Create a new integration. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.list List all integrations for a given app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.get Return the specified integration. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.update Update the specified integration. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.delete Delete the specified integration. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.menu.get Get the specified integration’s menu. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.menu.update Update the specified integration’s menu. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.menu.delete Delete the specified integration’s menu. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.profile.get Get the specified integration’s profile. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.profile.update Update the specified integration’s profile. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
integrations.profile.photo.upload Upload a photo to be used for the the specified integration’s profile. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
deployments Module
deployments.create Create a new deployment. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
deployments.activate Activate the phone number of the deployment. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
deployments.confirmCode Confirm the phone number of the deployment. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
deployments.get Return the specified deployment. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
deployments.list List all configured deployments. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
deployments.delete Delete the specified deployment. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts Module
serviceAccounts.create Create a new service account. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.list List all service accounts. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.get Get the specified service account. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.delete Delete the specified service account. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.keys.create Create a secret key for the specified service account. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.keys.list List all secret keys for the specified service account. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.keys.get Get a specified secret key for the specified service account. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.keys.delete Delete a specified secret key for the specified service account. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
serviceAccounts.keys.getJwt Get an account-scoped JWT signed using the requested keyId/secret pair. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
attachments Module
attachments.create Upload an attachment to Smooch to use in future messages. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
attachments.delete Remove an attachment uploaded to Smooch <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
templates Module
templates.create Create a new template. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
templates.list List all templates for a given app. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
templates.get Return the specified template. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
templates.update Update the specified template. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>
templates.delete Delete the specified template. <g-emoji class=“g-emoji” alias=“link” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f517.png”>🔗</g-emoji>

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-65022.html

文章标题:smooch-core

回到顶部