FusionPBX SMS Integration with Bandwidth

Robert Birch · May 3, 2021

OK. So I managed to get Bandwidth to connect to my server. I had to change the CallBack URL from HTTPS to HTTP. Guessing that is due to the testing and not a proper certificate in place.

But the only line in the NGINX access.log is this:

Code:

52.72.24.132 - - [03/May/2021:11:39:58 -0600] "POST /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1" 301 185 "-" "bandwidth-api"

Nothing in the error log either. Same with freeswitch.log. Nothing about the receiving of a message. MDR shows nothing as well.

Any other ideas?

Thanks,
Robert

Jonathan Black · May 3, 2021

Try browsing to this URL yourself and see what you get.

The access.log shows a 301, which is a redirect. Something in your nginx config may be redirecting back to https, which then fails.

Robert Birch · May 3, 2021

OK. I set up HTTPS with LetsEncrypt. Confirmed certificate is valid.
Sent another text message to the number. This is what I get in the access.log

Code:

52.72.24.132 - - [03/May/2021:12:54:34 -0600] "POST /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1" 301 185 "-" "bandwidth-api"
52.72.24.132 - - [03/May/2021:12:54:35 -0600] "GET /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1" 200 205 "-" "bandwidth-api"
52.72.24.132 - - [03/May/2021:12:55:09 -0600] "POST /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1" 502 173 "-" "bandwidth-api"
18.233.250.246 - - [03/May/2021:12:55:35 -0600] "POST /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1" 502 173 "-" "bandwidth-api"
52.72.24.132 - - [03/May/2021:12:57:16 -0600] "POST /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1" 502 173 "-" "bandwidth-api"
3.82.123.96 - - [03/May/2021:12:58:28 -0600] "POST /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1" 502 173 "-" "bandwidth-api"

And this in the error.log:

Code:

2021/05/03 12:57:16 [error] 7475#7475: *5646 upstream sent too big header while reading response header from upstream, client:
52.72.24.132, server: fusionpbx, request: "POST /app/sms/hook/sms_hook_bandwidth.php HTTP/1.1", upstream: "fastcgi://unix:/var/
run/php/php7.1-fpm.sock:", host: "testfusion.XXXXX.com"

Thanks

Jonathan Black · May 3, 2021

That is a new error to me. Here's something I found that may help. I don't know why it would be exceeding the buffer, but you might try the settings in the one of the answers to the linked question.

Robert Birch · May 3, 2021

Interesting side note.
I can see Bandwidth keep trying to resend the failed messages. Seems that in the error.log the logging seems to be cut off.
For example:

Code:

PHP message: [SMS] REQUEST: Array
(
    [0] => stdClass Object
        (
            [time] => 2021-05-03T17:35:16.221Z
            [type] => message-received
            [to] => +1<Inbound Number>
            [description] => Incoming message received
            [message] => stdClass Object
                (
                    [id] => a92b3882-803b-4a16-b49f-67605d51ea51
                    [owner] => +1<Inbound Number>
                    [applicationId] => xxxxxxx
                    [time] => 2021-05-03T17:35:16.056Z
                    [segmentCount] => 1
                    [direction] => in
                    [to] => Array
                        (
                            [0] => +1<Inbound Number>
                        )

                    [from] => +1<Sending Number>
                    [text] => Replying
                )

        )

)

PHP message: TO: 1<Inbound Number>
PHP message: FROM: 1<Sending Number>
PHP message: BODY: Rep

Strange that the logging stops where it does? I see all the entries stopping somewhere in that PHP message: BODY line.

Could I have something wrong with my hook file?

Thanks

Jonathan Black · May 3, 2021

No, that's one of those "feature-bugs". There is a buffer limit on the logging. I suspect it will only write a certain amount to the log at a time. It's writing a lot to the log for each inbound message, for troubleshooting purposes. It will cut off the log in the middle of a line, somewhere along the way. It probably needs something like a "dump" command somewhere in the common hook file, but I haven't bothered to research it, because it doesn't actually seem to impact any other operations.

Since it looks like you are actually receiving the message now, via the webhook, what comes before or after that snippet?

Also, there is a known issue with Bandwidth where they will keep retrying (for a while) if they don't receive back the response they are looking for. See earlier in this thread for solutions. (after you actually get it working/delivering the message, that is)

Robert Birch · May 3, 2021

This seems to be the whole log for the message. Seems like one entry? Is that correct?

Code:

Thanks

Robert Birch · May 3, 2021

If I check the MDRS section in fusion, I can see all the incoming messages now, so I am guessing the hook is working to some extent.

Robert Birch · May 3, 2021

Didn't notice there was actual Freeswitch logging for this as well.
Here is that if it helps:

Code:

2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] DIRECTION: inbound
2021-05-03 14:20:19.673367 [INFO] switch_cpp.cpp:1465 chat console
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] TO: 101@testfusion.xxxx.com
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] Extension: 101
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] FROM: 1<Sending Number>
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] BODY: New Test
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] DOMAIN_NAME: testfusion.xxxxx.com
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] MAILSENT (already): 1
2021-05-03 14:20:19.673367 [INFO] switch_cpp.cpp:1465 Event-Name: CUSTOM
Core-UUID: 75dd2cf6-5b4d-4e15-8274-5b82ff3e4186
FreeSWITCH-Hostname: fusion
FreeSWITCH-Switchname: fusion
FreeSWITCH-IPv4: <Internal IP>
FreeSWITCH-IPv6: fe80%3A%3A250%3A56ff%3Afe8a%3Ab584
Event-Date-Local: 2021-05-03%2014%3A20%3A19
Event-Date-GMT: Mon,%2003%20May%202021%2020%3A20%3A19%20GMT
Event-Date-Timestamp: 1620073219673367
Event-Calling-File: switch_cpp.cpp
Event-Calling-Function: Event
Event-Calling-Line-Number: 314
Event-Sequence: 35363
Event-Subclass: SMS%3A%3ASEND_MESSAGE
proto: sip
dest_proto: sip
from: sip%3A1<Sending Number>
from_user: 1<Sending Number>
from_host: testfusion.xxxxx.com
from_full: sip%3A1<Sending Number>%40testfusion.xxxxx.com
sip_profile: internal
to: 101%40testfusion.xxxxx.com
to_user: 101
to_host: testfusion.xxxxx.com
subject: SIMPLE%20MESSAGE
type: text/plain
hint: the%20hint
replying: true
DP_MATCH: 101%40testfusion.xxxxx.com
Content-Length: 8

New Test
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] SQL DOMAIN_NAME: SELECT domain_uuid FROM v_domains WHERE domain_name = :domain_name; params:{"domain_name":"testfusion.xxxxx.com"}
2021-05-03 14:20:19.673367 [DEBUG] mod_sms.c:92 SMS Delivery assumed successful due to being sent in non-blocking manner
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] SQL EXTENSION: SELECT extension_uuid FROM v_extensions WHERE domain_uuid = :domain_uuid and extension = :extension; params:{"domain_uuid":"<domain_uuid>","extension":"101"}
2021-05-03 14:20:19.673367 [NOTICE] switch_cpp.cpp:1465 [sms] SQL: insert into v_sms_messages(sms_message_uuid,extension_uuid,domain_uuid,start_stamp,from_number,to_number,message,direction,response,carrier) values (:uuid,:extension_uuid,:domain_uuid,now(),:from,:to,:body,:direction,'',:carrier); params:{"to":"101","direction":"inbound","domain_uuid":"<domain_uuid>","carrier":"","uuid":"88c85814-0c81-4186-b4fa-2bdc1fb2391a","from":"1<Sending Number>","body":"New Test","extension_uuid":"9e2e99fd-f8fb-46a1-bf71-2e053682c06f"}

Thanks

Robert Birch · May 3, 2021

Should also say adding:
fastcgi_buffers 16 16k;
fastcgi_buffer_size 32k;

to the nginx.conf file got rid of the upstream sent too big header while reading response header from upstream error.

Thanks

Robert Birch · May 3, 2021

UGH!!!! Don't I feel like an idiot. The message are actually getting through. I wasn't getting a notification for them in the GroundWire app, so didn't realize they were coming into the 1xxxxxxx verison of the number, not xxxxxxx version of the number.

I'm sorry, but I guess it is working now!!!!!

Thanks for all the help. I do appreciate it.

Jonathan Black · May 3, 2021

No problem. Yes, the whole 1+ thing on responses has bitten me a time or two. Glad it's working for you!

Regarding the log truncation, here's some info on that. I haven't tried changing the log_errors_max_len setting, but it sounds like that might work. Could even try the ini_set command at the start of the hook file.

mak_make · May 14, 2021

@Robert Birch are you still getting duplicate messages from Bandwidth? If yes you can get rid off them by turning off Call Back events at Applications tab on bandwidth portal. Because every call back that Bandwidth send is expect us to send them HTTP 200. Also I have changed the Hook file something like this:

PHP:

<?php

include "../root.php";

require_once "resources/require.php";
require_once "../sms_hook_common.php";

if ($debug) {
    error_log('[SMS] REQUEST: ' .  print_r($_SERVER, true));
}

if (check_acl()) {
    if  ($_SERVER['CONTENT_TYPE'] == 'application/json; charset=utf-8') {
        $data = json_decode(file_get_contents("php://input"));
        if ($debug) {
            error_log('[SMS] REQUEST: ' .  print_r($data, true));
        }
        route_and_send_sms($data[0]->message->from, $data[0]->to, $data[0]->message->text);
        
    } else {
        error_log('[SMS] REQUEST: No SMS Data Received');
        die("no");
    }
} else {
    error_log('ACCESS DENIED [SMS]: ' .  print_r($_SERVER['REMOTE_ADDR'], true));
    die("access denied");
}
?>

After this, I have stopped receiving the duplicate messages.

Robert Birch · May 14, 2021

Hey @mak_make

Did you turn off all three CallBack events? I did get the issue with a message being resent every 5 mins a couple of days ago. I was able to stop it by restarting NGINX, but this will be better if it just doesn't happen.

Thanks for the updated hook file. I'll get that in place and see how it goes.

Thanks,

mak_make · May 18, 2021

Yes turn off all three.

mak_make · May 21, 2021

@Jonathan Black Can you please shed some light on SMS Broadcast. I have a Tab and I have added a test Broadcast, but I don't see any option to start the broadcast.

Jonathan Black · Jun 7, 2021

mak_make said:
@Jonathan Black Can you please shed some light on SMS Broadcast. I have a Tab and I have added a test Broadcast, but I don't see any option to start the broadcast.

To my knowledge, there is no support built into this module for SMS Broadcast (AFAIK, the only broadcast built into FusionPBX is phone call broadcast, and even that is rudimentary). This SMS module is strictly intended as person-to-person usage though it already does have integration for voicemail notification--but this is still just to one person. You are welcome to proceed with develop of this on your own, but here are a couple of caveats:
1. SMS broadcast comes with a lot more considerations, such as handling opt-outs/DNC lists and so on. It may also change your rates with your carrier to a different category. Your going to find more regulatory issues than with person-to-person.
2. There may also be additional restrictions you want to put on this if you expose this to your users to use. Things like maximum number of messages and maybe message sending rate.
3. Because of these issues, it is very unlikely that any development you do on this would be approved to be included in the FusionPBX project, if you tried to contribute back to the project. (This is my opinion just based on what I've seen. I'm not involved in approving changes on the project.)

mak_make · Jun 11, 2021

@Jonathan Black Thanks for the info. Right know I am not trying to implement the Broadcast. I saw the option so got curious how it will work.

mak_make · Jun 11, 2021

@Jonathan Black I am wondering is their a way we can do SMS from the FusionPBX GUI instead of endpoints. I have seen an option called Messages is this related to SMS.

I have tried some testing's but it's not working

Jonathan Black · Jun 11, 2021

mak_make said:
@Jonathan Black I am wondering is their a way we can do SMS from the FusionPBX GUI instead of endpoints. I have seen an option called Messages is this related to SMS.

I have tried some testing's but it's not working

The Messages option is a built-in SMS messaging application that the author, @markjcrane, has been working for a year or two now (possibly longer). It never made it into full production, at least with support for more than one carrier. As I understand it, he is now actively working on a rewrite of this module, but doesn't have an ETA yet.

The SMS module was created by third parties. I didn't write it, but I have contributed some to it. It shares no code with the Messages module, and any configuration info you set up for the SMS module is separate from the Messages module (once it reaches full production release). I do not know if it will be possible to run the SMS and Messages modules side-by-side, but I suspect not.

Back to your original question: While there is no current support for SMS from within FusionPBX GUI, it should be possible to add this ability. I've actually given some thought to adding it, along with some other tweaks to the messages log (MDR) page. I've hesitated because I didn't want to duplicate efforts with what Mark is doing. However, if the Messaging module doesn't land in the next couple of months, I may revisit it.

FusionPBX SMS Integration with Bandwidth

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member

Member