Class Messagebird
- java.lang.Object
-
- com.zendesk.sunshine_conversations_client.model.Integration
-
- com.zendesk.sunshine_conversations_client.model.Messagebird
-
public class Messagebird extends Integration
Messagebird
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringJSON_PROPERTY_ACCESS_KEYstatic java.lang.StringJSON_PROPERTY_ORIGINATORstatic java.lang.StringJSON_PROPERTY_SIGNING_KEYstatic java.lang.StringJSON_PROPERTY_TYPEstatic java.lang.StringJSON_PROPERTY_WEBHOOK_SECRETprotected java.lang.Stringtype-
Fields inherited from class com.zendesk.sunshine_conversations_client.model.Integration
JSON_PROPERTY_DISPLAY_NAME, JSON_PROPERTY_ID, JSON_PROPERTY_STATUS
-
-
Constructor Summary
Constructors Constructor Description Messagebird()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MessagebirdaccessKey(java.lang.String accessKey)booleanequals(java.lang.Object o)java.lang.StringgetAccessKey()The public API key of your MessageBird account.java.lang.StringgetOriginator()Sunshine Conversations will receive all messages sent to this phone number.java.lang.StringgetSigningKey()The signing key of your MessageBird account.java.lang.StringgetType()To configure a MessageBird integration, acquire the accessKey, the signingKey and the MessageBird number you would like to use, then call the Create Integration endpoint.java.lang.StringgetWebhookSecret()The secret that is used to configure webhooks in MessageBird.inthashCode()Messagebirdoriginator(java.lang.String originator)voidsetAccessKey(java.lang.String accessKey)voidsetOriginator(java.lang.String originator)voidsetSigningKey(java.lang.String signingKey)voidsetType(java.lang.String type)MessagebirdsigningKey(java.lang.String signingKey)java.lang.StringtoString()Messagebirdtype(java.lang.String type)-
Methods inherited from class com.zendesk.sunshine_conversations_client.model.Integration
displayName, getDisplayName, getDisplayName_JsonNullable, getId, getStatus, setDisplayName, setDisplayName_JsonNullable, setStatus, status
-
-
-
-
Field Detail
-
JSON_PROPERTY_TYPE
public static final java.lang.String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
type
protected java.lang.String type
-
JSON_PROPERTY_ACCESS_KEY
public static final java.lang.String JSON_PROPERTY_ACCESS_KEY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SIGNING_KEY
public static final java.lang.String JSON_PROPERTY_SIGNING_KEY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORIGINATOR
public static final java.lang.String JSON_PROPERTY_ORIGINATOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_WEBHOOK_SECRET
public static final java.lang.String JSON_PROPERTY_WEBHOOK_SECRET
- See Also:
- Constant Field Values
-
-
Method Detail
-
type
public Messagebird type(java.lang.String type)
- Overrides:
typein classIntegration
-
getType
@Nullable public java.lang.String getType()
To configure a MessageBird integration, acquire the accessKey, the signingKey and the MessageBird number you would like to use, then call the Create Integration endpoint. The response will include the integration’s `_id` and `webhookSecret`, which must be used to configure the webhook in MessageBird. In the Flow Builder for the MessageBird number you’ve used to integrate, add a new step with the following settings: - Create a new Call HTTP endpoint with SMS flow. - Select your desired SMS number for Incoming SMS. - Click on Forward to URL and set its method to POST. - Then, using the integration _id and webhookSecret returned from the create integration call, enter the following into the URL field: `https://app.smooch.io/api/messagebird/webhooks/{appId}/{integrationId}/{webhookSecret}` - Select application/json for the Set Content-Type header field. - Save and publish your changes.- Overrides:
getTypein classIntegration- Returns:
- type
-
setType
public void setType(java.lang.String type)
- Overrides:
setTypein classIntegration
-
accessKey
public Messagebird accessKey(java.lang.String accessKey)
-
getAccessKey
public java.lang.String getAccessKey()
The public API key of your MessageBird account.- Returns:
- accessKey
-
setAccessKey
public void setAccessKey(java.lang.String accessKey)
-
signingKey
public Messagebird signingKey(java.lang.String signingKey)
-
getSigningKey
public java.lang.String getSigningKey()
The signing key of your MessageBird account. Used to validate the webhooks' origin.- Returns:
- signingKey
-
setSigningKey
public void setSigningKey(java.lang.String signingKey)
-
originator
public Messagebird originator(java.lang.String originator)
-
getOriginator
public java.lang.String getOriginator()
Sunshine Conversations will receive all messages sent to this phone number.- Returns:
- originator
-
setOriginator
public void setOriginator(java.lang.String originator)
-
getWebhookSecret
@Nullable public java.lang.String getWebhookSecret()
The secret that is used to configure webhooks in MessageBird.- Returns:
- webhookSecret
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classIntegration
-
hashCode
public int hashCode()
- Overrides:
hashCodein classIntegration
-
toString
public java.lang.String toString()
- Overrides:
toStringin classIntegration
-
-