-
Notifications
You must be signed in to change notification settings - Fork 909
/
README
154 lines (98 loc) · 2.96 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
Slack Module
Arsen Semenov
<arsperger@gmail.com>
Copyright © 2021 arsperger.com
__________________________________________________________________
Table of Contents
1. Admin Guide
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. slack url (str)
3.2. channel (str)
3.3. username (str)
3.4. icon_emogi (str)
4. Functions
4.1. slack_send(format)
List of Examples
1.1. Set slack webhook URL parameter
1.2. Set channel parameter
1.3. Set username parameter
1.4. Set icon_emogi parameter
1.5. slack_send usage
Chapter 1. Admin Guide
Table of Contents
1. Overview
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
3. Parameters
3.1. slack url (str)
3.2. channel (str)
3.3. username (str)
3.4. icon_emogi (str)
4. Functions
4.1. slack_send(format)
1. Overview
This module provides integration with Slack over webhooks. Slack
integration (https://api.slack.com/messaging/webhooks)
It relays on libcurl. library (https://curl.se/libcurl).
2. Dependencies
2.1. Kamailio Modules
2.2. External Libraries or Applications
2.1. Kamailio Modules
The following modules must be loaded before this module:
* none.
2.2. External Libraries or Applications
The following libraries or applications must be installed before
running Kamailio with this module loaded:
* libcurl
3. Parameters
3.1. slack url (str)
3.2. channel (str)
3.3. username (str)
3.4. icon_emogi (str)
3.1. slack url (str)
Slack webhook url
Default value is not set (empty)
Example 1.1. Set slack webhook URL parameter
...
modparam("slack", "slack_url", "https://hooks.slack.com/services/T00000000/B0000
0000/XXXXXXXXXXXXXXXXXXXXXXXX")
...
3.2. channel (str)
Slack channel name
Default value is #kamailio
Example 1.2. Set channel parameter
...
modparam("slack", "channel", "#kamailio")
...
3.3. username (str)
Specify the username for the published message
Default value is webhookbot.
Example 1.3. Set username parameter
...
modparam("slack", "username", "webhookbot")
...
3.4. icon_emogi (str)
specify an emoji (using colon shortcodes, eg. :white_check_mark:) to
use as the profile photo alongside the message.
Default value is :ghost:
Example 1.4. Set icon_emogi parameter
...
modparam("slack", "icon_emogi", ":ghost:")
...
4. Functions
4.1. slack_send(format)
4.1. slack_send(format)
Send a formatted message to slack channel.
The parameters are:
* format - The formatted string to be send.
The parameters can contain pseudo-variables.
This function can be used from ANY_ROUTE.
Example 1.5. slack_send usage
...
slack_send("Hello from Kamailio! caller=$fU;callee=$tU;callid=$ci");
...